General Class Functions
General Class Functions

These functions can be used by all object classes.

Flags
SetFlagSets a flag of all child instances ON or OFF
SetFlagOnSets a flag of all child instances ON
SetFlagOffSets a flag of all child instances OFF
ToggleFlagToggles a flag of all child instances
IsFlagOnReturns TRUE if any instances have the flag turned ON
IsFlagOffReturns TRUE if any instances have the flag turned OFF
SelectFlagSelects all the instances which have the given flag ON / OFF
Alterable Values
SetAlterableValueChanges an alterable value for all instances
AddToAlterableValueAdds to an alterable value for all instances
GetAlterableValueReturns an alterable value from the first selected instance
SelectAlterableValueSelects all instances with the given alterable value
Position
SetPositionChanges the position of all instances
SetXChanges the x position of all instances
SetYChanges the y position of all instances
GetXReturns the x position of the first selected instance
GetYChanges the y position of the first selected instance
SelectXSelects all instances with the given x coordinate
SelectYSelects all instances with the given y coordinate
Size
SetSizeChanges the size of all instances
SetWidthChanges the width of all instances
SetHeightChanges the height of all instances
GetWidthReturns the width of the first selected instance
GetHeightReturns the height of the first selected instance
Movement
SetMovementChanges the movement type of the object
GetMovementReturns the movement type of the object
SetPlayerChanges the controlling player for the object
GetPlayerReturns the controlling player for the object
SetDirectionChanges the direction of the object
GetDirectionReturns the direction of the object
AddToDirectionAdds to the direction of the object
SetSpeedChanges the speed of the object
GetSpeedReturns the speed of the object
AddToSpeedAdds to the objects speed
SelectDirectionSelects all instances with the given direction
SelectSpeedSelects all instances with the given speed
StartStarts the movement
StopStops the movement
PausePauses the movement
ResumeResumes the movement
IsPausedChecks if the object is currently paused
BounceCauses the movement to bounce based on the last known collision angle
BounceAtCauses the movement to bounce based on the given collision angle
Display
SetDrawModeChanges the ink effect of the object
GetDrawModeReturns the ink effect of the object
GetSemiTransReturns the semi-transparency of the object
SelectDrawModeSelects instances based on their draw mode
SelectSemiTransSelects instances based on their semi-transparency
SetTransparentModeTurns transparency on or off
IsTransparentModeChecks if transparency is currently on
SelectTransparentModeSelects objects which have transparent mode turned on
SelectTransparentModeONFrontend for SelectTransparentMode
SelectTransparentModeOFFSelects objects which have transparent mode turned off
SetVisibleShows / Hides the object
ShowShows the object
HideHides the object
IsVisibleChecks if the object is visible
SelectVisibleSelects instances which are visible
SelectInvisibleSelects instances which are invisible
PasteIntoBackgroundPastes an image of the object into the main background surface
SetRotationChanges the rotation angle of the object
GetRotationReturns the rotation angle of the object
Behaviours
SetBehaviourChanges the behaviour of all instances
GetBehaviourReturns the bahaviour of the instances
Stick-to-screen
SetStuckMakes the object stick or unstick to the screen
StickAlias of SetStuck
UnStickAlias of SetStuck( FALSE )
UnStuckChecks if the object is currently stuck to the screen
SelectStuckSelects objects based on if they are stuck to the screen
Layering
ForwardRaises the object's z-depth
BackwardLowers the object's z-depth
ToFrontMoves the object to the highest z-depth
ToBackMoves the object to the lowest z-depth
Collisions
IsLeavingScreenChecks if the object is leaving the screen in any direction
IsLeavingScreenRightChecks if the object is leaving the screen to the right
IsLeavingScreenLeftChecks if the object is leaving the screen to the left
IsLeavingScreenTopChecks if the object is leaving the screen to the top
IsLeavingScreenBottomChecks if the object is leaving the screen to the bottom
IsLeavingZoneChecks if the object is leaving a zone in any direction
IsCollideWithChecks if the object is colliding with another object
IsCollideBackgroundChecks if the object is colliding with the background
IsOverChecks if the object is overlapping another object
IsOverBackgroundChecks if the object is overlapping the background
SelectOverSelects instances based on overlapping another object
SelectOverBackgroundSelects instances based on overlapping the background
SelectInScreenSelects instances based on whether they are within the screen
SetCollisionAngleForces a custom collision angle
GetCollisionAngleReturns the last collision angle
SelectCollisionAngleSelects instances based on their collision angle
Special
SelectAllSelects all instances
SelectNoneDe-selects all instances
SelectInverseInverts the current selection
SelectAtRandomSelects an instance at random
DestroySelectedDestroys all currently selected instances
GetUniqueIDReturns the unique ID of the first selected instance
SelectIDSelects an instance based on it's unique ID
CountReturns the total number of instances of the object
CountSelectedReturns the total number of currently selected instances



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