API
API|
@babylonjs/core|
ISpriteMapOptions

Interface ISpriteMapOptions

Defines the basic options interface of a SpriteMap

interface ISpriteMapOptions {
    baseTile?: number;
    colorMultiply?: Vector3;
    flipU?: boolean;
    frameRotationDirection?: SpriteMapFrameRotationDirection;
    layerCount?: number;
    maxAnimationFrames?: number;
    outputPosition?: Vector3;
    outputRotation?: Vector3;
    outputSize?: Vector2;
    stageSize?: Vector2;
}
Index
baseTile? colorMultiply? flipU? frameRotationDirection? layerCount? maxAnimationFrames? outputPosition? outputRotation? outputSize? stageSize?
baseTile?: number

number cell index of the base tile when the system compiles.

colorMultiply?: Vector3

Vector3 scalar of the global RGB values of the SpriteMap.

flipU?: boolean

boolean flip the sprite after its been repositioned by the framing data.

frameRotationDirection?: SpriteMapFrameRotationDirection

Rotation direction of the frame by 90 degrees. Applied when the the frame's "rotated" parameter is true. Default is CCW.

layerCount?: number

number of layers that the system will reserve in resources.

maxAnimationFrames?: number

number of max animation frames a single cell will reserve in resources.

outputPosition?: Vector3

Vector3 of the position of the output plane in World Units.

outputRotation?: Vector3

Vector3 of the rotation of the output plane.

outputSize?: Vector2

Vector2 of the size of the output plane in World Units.

stageSize?: Vector2

Vector2 of the number of cells in the grid.