JAM
JAM
The JAM object is the base of your program. It's function list is minimal, favouring access through the special objects.
Creation
JAM
Creates a new JAM object
Functions
Game Info
About
Displays the credits for the JAM object
SetInfo
Sets the information displayed in the about box
SetTrusted
Sets whether the run/etc. code is trusted
IsTrusted
Returns the trust level
GetVersion
Returns the version of the JAM object
Screensavers
SetSettingsProperties
Changes the appearance of the settings window
GetSettingsINI
Changes the appearance of the settings window
Objects
Create
Creates a new object in the main layer
CreateGUI
Creates a new object in the GUI layer
Delete
Deletes an object safely
ClearFrame
Clears the frame completley
Backgrounds & foregrounds
NewBackground
Adds a background to the window
NewForeground
Adds a foreground to the window
SetTransparentBackground
Specifies whether the back-most background should have transparency
IsTransparentBackground
Returns TRUE if the back-most background is using transparency
SetMainBackground
Sets the main background surface
SetCollisionMask
Sets the main collision mask surface
GetMainBackground
Returns the main background surface
GetCollisionMask
Returns the main collision mask surface
Overlay
SetOverlay
Sets the overlay object for the window
GetOverlay
Returns the overlay attatched to the window
Modes
SetResizeMode
Sets the resize mode of the game
GetResizeMode
Returns the resize mode of the game
GetBorderColor
Returns the border colour of the window when in BORDER mode
SetAutoEnd
Turns ON or OFF the automatic ending of the project when the game ends
SetAutoPause
Turns ON or OFF the in-built pause methods
Runtime
Run
Begins the game loop
Pause
Pauses the game
Resume
Resumes the game
Callback
OnDraw
Called just before the window is refreshed each loop
OnError
Called when the JAM object encounters an error
OnPause
Called when the game pauses
OnResume
Called when the game resumes
Advanced use
GetTargetSurface
Returns the game surface
Regen
Progresses the game 1 frame
Refresh
Re-draws the current frame to the window
RenderToSurface
Renders the current frame to a surface
RefreshWindow
Refreshes the game window
JAM © 2005 no one in particular
Project started by David Evans in 2005