Class SpriteMap

constructor

• new SpriteMap(
      name: string,
      atlasJSON: ISpriteJSONAtlas,
      spriteSheet: Texture,
      options: ISpriteMapOptions,
      scene: Scene,
  ): SpriteMap

  Creates a new SpriteMap

  Parameters

  • name: string

    defines the SpriteMaps Name

  • atlasJSON: ISpriteJSONAtlas

    is the JSON file that controls the Sprites Frames and Meta

  • spriteSheet: Texture

    is the Texture that the Sprites are on.

  • options: ISpriteMapOptions

    a basic deployment configuration

  • scene: Scene

    The Scene that the map is deployed on

  Returns SpriteMap

atlasJSON

name

options

sprites

spriteSheet

animationMap

• get animationMap(): RawTexture

  Sets the AnimationMap

  Returns RawTexture

• set animationMap(v: RawTexture): void

  Sets the AnimationMap

  Parameters

  • v: RawTexture

  Returns void

fogEnabled

• get fogEnabled(): boolean

  Gets or sets a boolean indicating if the sprite map must consider scene fog when rendering

  Returns boolean

• set fogEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

position

• get position(): Vector3

  Returns the Position of Output Plane

  Returns Vector3

• set position(v: Vector3): void

  Returns the Position of Output Plane

  Parameters

  • v: Vector3

  Returns void

rotation

• get rotation(): Vector3

  Returns the Rotation of Output Plane

  Returns Vector3

• set rotation(v: Vector3): void

  Returns the Rotation of Output Plane

  Parameters

  • v: Vector3

  Returns void

spriteCount

• get spriteCount(): number

  Returns the Number of Sprites in the System

  Returns number

useLogarithmicDepth

• get useLogarithmicDepth(): boolean

  Gets or sets a boolean indicating if the sprite map must use logarithmic depth when rendering

  Returns boolean

• set useLogarithmicDepth(value: boolean): void

  Parameters

  • value: boolean

  Returns void

addAnimationToTile

• addAnimationToTile(
      cellID?: number,
      _frame?: number,
      toCell?: number,
      time?: number,
      speed?: number,
  ): void

  Modifies the data of the animationMap

  Parameters

  • cellID: number = 0

    is the Index of the Sprite

  • _frame: number = 0

    is the target Animation frame

  • toCell: number = 0

    is the Target Index of the next frame of the animation

  • time: number = 0

    is a value between 0-1 that is the trigger for when the frame should change tiles

  • speed: number = 1

    is a global scalar of the time variable on the map.

  Returns void

changeTiles

• changeTiles(_layer?: number, pos: Vector2 | Vector2[], tile?: number): void

  Modifies the data of the tileMaps

  Parameters

  • _layer: number = 0

    is the ID of the layer you want to edit on the SpriteMap

  • pos: Vector2 | Vector2[]

    is the iVector2 Coordinates of the Tile

  • tile: number = 0

    The SpriteIndex of the new Tile

  Returns void

dispose

• dispose(): void

  Release associated resources

  Returns void

getMousePosition

• getMousePosition(): Vector2

  Gets the UV location of the mouse over the SpriteMap.

  Returns Vector2

  Vector2 the UV position of the mouse interaction

getTileID

• getTileID(): Vector2

  Returns tileID location

  Returns Vector2

  Vector2 the cell position ID

getTileIdxByName

• getTileIdxByName(name: string): number

  Returns the index of the frame for a given filename

  Parameters

  • name: string

    filename of the frame

  Returns number

  index of the frame

loadTileMaps

• loadTileMaps(url: string): void

  Imports the .tilemaps file

  Parameters

  • url: string

    of the .tilemaps file

  Returns void

saveTileMaps

• saveTileMaps(): void

  Exports the .tilemaps file

  Returns void