Common expressions

The following expressions are common to several plugins.

Angle

Angle
The object's current angle, in degrees. 0 degrees is facing right and angles increment clockwise.

Appearance

Opacity
The object's current opacity (semitransparency), from 0 (transparent) to 100 (opaque).

Misc

AsJSON
Save the object state to a string of data in JSON format, and return it. This can be downloaded or otherwise stored, and later the state of the object restored using the Set from JSON action.

Count
The number of instances of the object type.

PickedCount
The number of instances meeting the event's conditions. For example, if the event has the condition "Mouse is over Sprite", Sprite.PickedCount will return the number of Sprite instances that the mouse is over.

IID
Return the instance's index ID (IID). See common features.

UID
Return the instance's unique ID (UID). See common features.

Size & Position

BBoxLeft
BBoxRight
BBoxTop
BBoxBottom
Return the layout co-ordinates of the object's axis-aligned bounding box. This is the smallest unrotated box that completely encloses the object, taking in to account any rotation or stretching.

Width
Height
Return the size of the object in pixels.

ImagePointX
ImagePointY
Return the position of one of the object's image points in layout co-ordinates. Either the image point's name or its number can be passed.

X
Y
Return the object's position in the layout, in pixels. The origin (0,0) is at the top-left of the layout and the Y axis increments downwards.

Time

dt
Return delta-time according to the object's own timescale. See Delta-time and framerate independence for more information.

Z Order

LayerName
The name of the layer the instance is currently on.

LayerNumber
The zero-based index of the layer the instance is currently on.

ZIndex
Get the zero-based index of the Z order of this instance within its current layer. 0 is the bottom instance, increasing up to the top instance.

Tags: