CmdFX_SpriteCostumes Struct Reference

Represents the holder for sprite costumes. More...

#include <costumes.h>

Public Attributes
char ***	costumes
	Represents the sprite costumes.
char ****	ansiCostumes
	Represents the ANSI codes for the sprite costumes.
int	costumeCount
	Represents the number of sprite costumes.

Detailed Description

Represents the holder for sprite costumes.

This struct is used to hold sprite costumes. A sprite costume is a state of a sprite. For example, a sprite costume could be a sprite with a different color, or a sprite with a different shape.

This is automatically constructed and freed along with the sprite using Sprite_create and Sprite_free.

Member Data Documentation

ansiCostumes

char**** CmdFX_SpriteCostumes::ansiCostumes

Represents the ANSI codes for the sprite costumes.

This is a 3D array of strings. The first dimension is the costume index, the second dimension is the row, and the third dimension is the ANSI code.

This array must match the same length as the costumes array. costumeCount must be the same length as the first dimension of this array. ANSI costumes can be initialized to 0 to account for no ANSI codes.

There is an internal limit of 128 costumes per sprite.

costumeCount

int CmdFX_SpriteCostumes::costumeCount

Represents the number of sprite costumes.

This is the number of sprite costumes in the costumes and the ansiCostumes arrays.

There is an internal limit of 128 costumes per sprite.

costumes

char*** CmdFX_SpriteCostumes::costumes

Represents the sprite costumes.

This is a 3D array of characters. The first dimension is the costume index, the second dimension is the row, and the third dimension is the column.

This array must match the same length as the ansiCostumes array. costumeCount must be the same length as the first dimension of this array.

There is an internal limit of 128 costumes per sprite.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/cmdfx/cmdfx/include/cmdfx/core/costumes.h