General Class Functions
General Class Functions
These functions can be used by all object classes.
Flags
SetFlag
Sets a flag of all child instances ON or OFF
SetFlagOn
Sets a flag of all child instances ON
SetFlagOff
Sets a flag of all child instances OFF
ToggleFlag
Toggles a flag of all child instances
IsFlagOn
Returns TRUE if any instances have the flag turned ON
IsFlagOff
Returns TRUE if any instances have the flag turned OFF
SelectFlag
Selects all the instances which have the given flag ON / OFF
Alterable Values
SetAlterableValue
Changes an alterable value for all instances
AddToAlterableValue
Adds to an alterable value for all instances
GetAlterableValue
Returns an alterable value from the first selected instance
SelectAlterableValue
Selects all instances with the given alterable value
Position
SetPosition
Changes the position of all instances
SetX
Changes the x position of all instances
SetY
Changes the y position of all instances
GetX
Returns the x position of the first selected instance
GetY
Changes the y position of the first selected instance
SelectX
Selects all instances with the given x coordinate
SelectY
Selects all instances with the given y coordinate
Size
SetSize
Changes the size of all instances
SetWidth
Changes the width of all instances
SetHeight
Changes the height of all instances
GetWidth
Returns the width of the first selected instance
GetHeight
Returns the height of the first selected instance
Movement
SetMovement
Changes the movement type of the object
GetMovement
Returns the movement type of the object
SetPlayer
Changes the controlling player for the object
GetPlayer
Returns the controlling player for the object
SetDirection
Changes the direction of the object
GetDirection
Returns the direction of the object
AddToDirection
Adds to the direction of the object
SetSpeed
Changes the speed of the object
GetSpeed
Returns the speed of the object
AddToSpeed
Adds to the objects speed
SelectDirection
Selects all instances with the given direction
SelectSpeed
Selects all instances with the given speed
Start
Starts the movement
Stop
Stops the movement
Pause
Pauses the movement
Resume
Resumes the movement
IsPaused
Checks if the object is currently paused
Bounce
Causes the movement to bounce based on the last known collision angle
BounceAt
Causes the movement to bounce based on the given collision angle
Display
SetDrawMode
Changes the ink effect of the object
GetDrawMode
Returns the ink effect of the object
GetSemiTrans
Returns the semi-transparency of the object
SelectDrawMode
Selects instances based on their draw mode
SelectSemiTrans
Selects instances based on their semi-transparency
SetTransparentMode
Turns transparency on or off
IsTransparentMode
Checks if transparency is currently on
SelectTransparentMode
Selects objects which have transparent mode turned on
SelectTransparentModeON
Frontend for SelectTransparentMode
SelectTransparentModeOFF
Selects objects which have transparent mode turned off
SetVisible
Shows / Hides the object
Show
Shows the object
Hide
Hides the object
IsVisible
Checks if the object is visible
SelectVisible
Selects instances which are visible
SelectInvisible
Selects instances which are invisible
PasteIntoBackground
Pastes an image of the object into the main background surface
SetRotation
Changes the rotation angle of the object
GetRotation
Returns the rotation angle of the object
Behaviours
SetBehaviour
Changes the behaviour of all instances
GetBehaviour
Returns the bahaviour of the instances
Stick-to-screen
SetStuck
Makes the object stick or unstick to the screen
Stick
Alias of SetStuck
UnStick
Alias of SetStuck( FALSE )
UnStuck
Checks if the object is currently stuck to the screen
SelectStuck
Selects objects based on if they are stuck to the screen
Layering
Forward
Raises the object's z-depth
Backward
Lowers the object's z-depth
ToFront
Moves the object to the highest z-depth
ToBack
Moves the object to the lowest z-depth
Collisions
IsLeavingScreen
Checks if the object is leaving the screen in any direction
IsLeavingScreenRight
Checks if the object is leaving the screen to the right
IsLeavingScreenLeft
Checks if the object is leaving the screen to the left
IsLeavingScreenTop
Checks if the object is leaving the screen to the top
IsLeavingScreenBottom
Checks if the object is leaving the screen to the bottom
IsLeavingZone
Checks if the object is leaving a zone in any direction
IsCollideWith
Checks if the object is colliding with another object
IsCollideBackground
Checks if the object is colliding with the background
IsOver
Checks if the object is overlapping another object
IsOverBackground
Checks if the object is overlapping the background
SelectOver
Selects instances based on overlapping another object
SelectOverBackground
Selects instances based on overlapping the background
SelectInScreen
Selects instances based on whether they are within the screen
SetCollisionAngle
Forces a custom collision angle
GetCollisionAngle
Returns the last collision angle
SelectCollisionAngle
Selects instances based on their collision angle
Special
SelectAll
Selects all instances
SelectNone
De-selects all instances
SelectInverse
Inverts the current selection
SelectAtRandom
Selects an instance at random
DestroySelected
Destroys all currently selected instances
GetUniqueID
Returns the unique ID of the first selected instance
SelectID
Selects an instance based on it's unique ID
Count
Returns the total number of instances of the object
CountSelected
Returns the total number of currently selected instances
JAM © 2005 no one in particular
Project started by David Evans in 2005