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 kinds:	all kinds except "line"

Figure clip field

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

Emitted variable type:	clip
Supported figure kinds:	"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.

For the "tilemap" and "tile" figure kinds, this color determines the appearance of the bitmap's transparent background.

Emitted variable type:	byte, pair, or int
Supported figure kinds:	all kinds except "clip"

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 symbol's figure.

If true, the figure's image is flipped horizontally on the board. (In order to see this result in the virtual machine, the emitted data must somehow apply this field to io_sprite::flags.)

Emitted variable type:	bool
Supported figure kinds:	"clip"

Figure flip Y field

The "Flip Y" checkbox for this symbol's figure.

If true, the figure's image is flipped vertically on the board. (In order to see this result in the virtual machine, the emitted data must somehow apply this field to io_sprite::flags.)

Emitted variable type:	bool
Supported figure kinds:	"clip"

Figure frame index field

The animation frame index number from the symbol's figure.

When displayed on the board, the clip does not animate; instead, the property pane allows you to choose one animation frame that the figure will show.

Emitted variable type:	byte, pair, or int
Supported figure kinds:	"clip"

Figure matte color field

The matte color number from the symbol's figure.

Each cell in a tilemap can optionally enable matte coloring, which normally causes the transparent pixels of that tile to be replaced with io::matte_color. Although io::matte_color is a single global setting for the virtual machine, the boards system allows each tilemap figure to specify its own custom matte color value. This field provides a way to emit that value.

Emitted variable type:	byte, pair, or int
Supported figure kinds:	"tilemap"

Figure rotate field

The "Rotate 90°" checkbox for this symbol's figure.

If true, then the figure's image is rotated clockwise 90 degrees on the board. (In order to see this result in the virtual machine, the emitted data must somehow apply this field to io_sprite::flags.)

The image must be square (equal width and height), otherwise the image is not rotated.

Emitted variable type:	bool
Supported figure kinds:	"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 kinds:	"line"

Figure theme field

The theme number from the symbol's figure.

Emitted variable type:	byte, pair, or int
Supported figure kinds:	"tile" or "clip"

Figure tile index field

The tile index number from the symbol's figure.

Emitted variable type:	byte, pair, or int
Supported figure kinds:	"tile"

Figure tilemap field

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

Emitted variable type:	tilemap
Supported figure kinds:	"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 kinds:	"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 symbol.

Emitted variable type:	bool
Supported figure kinds:	all figure kinds