JAM
JAM

The JAM object is the base of your program. It's function list is minimal, favouring access through the special objects.

Creation
 
JAMCreates a new JAM object
Functions
 
Game Info
AboutDisplays the credits for the JAM object
SetInfoSets the information displayed in the about box
SetTrustedSets whether the run/etc. code is trusted
IsTrustedReturns the trust level
GetVersionReturns the version of the JAM object
Screensavers
SetSettingsPropertiesChanges the appearance of the settings window
GetSettingsINIChanges the appearance of the settings window
Objects
CreateCreates a new object in the main layer
CreateGUICreates a new object in the GUI layer
DeleteDeletes an object safely
ClearFrameClears the frame completley
Backgrounds & foregrounds
NewBackgroundAdds a background to the window
NewForegroundAdds a foreground to the window
SetTransparentBackgroundSpecifies whether the back-most background should have transparency
IsTransparentBackgroundReturns TRUE if the back-most background is using transparency
SetMainBackgroundSets the main background surface
SetCollisionMaskSets the main collision mask surface
GetMainBackgroundReturns the main background surface
GetCollisionMaskReturns the main collision mask surface
Overlay
SetOverlaySets the overlay object for the window
GetOverlayReturns the overlay attatched to the window
Modes
SetResizeModeSets the resize mode of the game
GetResizeModeReturns the resize mode of the game
GetBorderColorReturns the border colour of the window when in BORDER mode
SetAutoEndTurns ON or OFF the automatic ending of the project when the game ends
SetAutoPauseTurns ON or OFF the in-built pause methods
Runtime
RunBegins the game loop
PausePauses the game
ResumeResumes the game
Callback
OnDrawCalled just before the window is refreshed each loop
OnErrorCalled when the JAM object encounters an error
OnPauseCalled when the game pauses
OnResumeCalled when the game resumes
Advanced use
GetTargetSurfaceReturns the game surface
RegenProgresses the game 1 frame
RefreshRe-draws the current frame to the window
RenderToSurfaceRenders the current frame to a surface
RefreshWindowRefreshes the game window



JAM © 2005 no one in particular
Project started by David Evans in 2005