Skip to main content

Field types (figure-based)

Figure caption field

A string that stores the "caption" or text" from the symbol's figure.

Emitted variable type:BYTE[] or STRING
Supported figure types:"clip"

Figure clip field

A pointer to the clip from the symbol's figure.

Emitted variable type:CLIP
Supported figure types:"clip"

Note: This field emits the clip of the symbol's figure. To store an arbitrary clip, use the regular clip field type instead.

Figure color field

The color number from the symbol's figure.

Emitted variable type:BYTE, PAIR, or INT
Supported figure types:anything except "clip" or "tile"

Note: This field emits the color of the symbol's figure. To store an arbitrary color, use the regular color field type instead.

Figure flip X field

The "FLIP X" checkbox for this the symbol.

Emitted variable type:BOOL
Supported figure types:"clip"

Figure flip Y field

The "FLIP Y" checkbox for this the symbol.

Emitted variable type:BOOL
Supported figure types:"clip"

Figure rotate field

The "ROTATE 90°" checkbox for this the symbol.

Emitted variable type:BOOL
Supported figure types:"clip"

Figure points field

An array of points (x0, y0, x1, y1, …) from the symbol's figure.

Emitted variable type:BYTE[], PAIR[], or INT[]
Supported figure types:"line"

Figure theme field

The theme number from the symbol's figure.

Emitted variable type:BYTE, PAIR, or INT
Supported figure types:"tilemap" or "clip"

Figure tile index field

The tile index number from the symbol's figure.

Emitted variable type:BYTE, PAIR, or INT
Supported figure types:"tile"

Figure tilemap field

A pointer to the tilemap from the symbol's figure.

Emitted variable type:TILEMAP
Supported figure types:"tilemap"

Note: This field emits the tilemap of the symbol's figure. To store an arbitrary tilemap, use the regular tilemap field type instead.

Figure tileset field

A pointer to the tileset from the symbol's figure.

Emitted variable type:TILESET
Supported figure types:"tilemap" or "tile"

Note: This field emits the tileset of the symbol's figure. To store an arbitrary tileset, use the regular tileset field type instead.

Figure underlay field

The "UNDERLAY" checkbox for this the symbol.

Emitted variable type:BOOL
Supported figure types:all figure types