Interface ISpriteSheet

Represents a sprite sheet: An image that contains multiple sprites in it, with some rules on how to read the sprites to perform an animation (usually).

Namespace: AGS.API
Assembly: AGS.API.dll
Syntax
public interface ISpriteSheet

Properties

| Improve this Doc View Source

CellHeight

Gets the height of the cell (in pixels).

Declaration
int CellHeight { get; }
Property Value
Type Description
System.Int32

The height of the cell (in pixels).
| Improve this Doc View Source

CellsToGrab

Gets the number of cells to grab when reading the sprite sheet.

Declaration
int CellsToGrab { get; }
Property Value
Type Description
System.Int32

The number of cells to grab.
| Improve this Doc View Source

CellWidth

Gets the width of the cell (in pixels).

Declaration
int CellWidth { get; }
Property Value
Type Description
System.Int32

The width of the cell (in pixels).
| Improve this Doc View Source

Order

Tells the engine how to read the sprite sheet (in what order).

Declaration
SpriteSheetOrder Order { get; }
Property Value
Type Description
SpriteSheetOrder

The reading order.
| Improve this Doc View Source

Path

Gets the sprite sheet path (either the resource path, or the machine path).

Declaration
string Path { get; }
Property Value
Type Description
System.String

The path.
| Improve this Doc View Source

StartFromCell

Which cell should we start from, when reading the sprite sheet?

Declaration
int StartFromCell { get; }
Property Value
Type Description
System.Int32

The 'start from' cell.