Babylon.js API documentation|

Class SpriteMap

Class used to manage a grid restricted sprite deployment on an Output plane.

Hierarchy

SpriteMap

Implements

ISpriteMap

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in .temp/docdirectory/doc.d.ts:106899
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

Properties

atlasJSON Search playground for atlasJSON

atlasJSON: ISpriteJSONAtlas

The JSON file with the frame and meta data

name Search playground for name

name: string

The Name of the spriteMap

options Search playground for options

options: ISpriteMapOptions

Arguments passed with the Constructor

spriteSheet Search playground for spriteSheet

spriteSheet: Texture

The systems Sprite Sheet Texture

sprites Search playground for sprites

sprites: ISpriteJSONSprite[]

Public Sprite Storage array, parsed from atlasJSON

Accessors

animationMap

get animationMap(): RawTexture
set animationMap(v: RawTexture): void

- Defined in .temp/docdirectory/doc.d.ts:106874
Sets the AnimationMap

Returns RawTexture
- Defined in .temp/docdirectory/doc.d.ts:106876
Sets the AnimationMap

Parameters
- v: RawTexture
Returns void

position

get position(): Vector3
set position(v: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:106866
Returns the Position of Output Plane

Returns Vector3
- Defined in .temp/docdirectory/doc.d.ts:106868
Returns the Position of Output Plane

Parameters
- v: Vector3
Returns void

rotation

get rotation(): Vector3
set rotation(v: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:106870
Returns the Rotation of Output Plane

Returns Vector3
- Defined in .temp/docdirectory/doc.d.ts:106872
Returns the Rotation of Output Plane

Parameters
- v: Vector3
Returns void

spriteCount

get spriteCount(): number

- Defined in .temp/docdirectory/doc.d.ts:106864
Returns the Number of Sprites in the System

Returns number

Methods

addAnimationToTile Search playground for addAnimationToTile

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

- Defined in .temp/docdirectory/doc.d.ts:106951
Modifies the data of the animationMap

Parameters
- Optional cellID: number
  
  is the Index of the Sprite
- Optional _frame: number
  
  is the target Animation frame
- Optional toCell: number
  
  is the Target Index of the next frame of the animation
- Optional time: number
  
  is a value between 0-1 that is the trigger for when the frame should change tiles
- Optional speed: number
  
  is a global scalar of the time variable on the map.
Returns void

changeTiles Search playground for changeTiles

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

- Defined in .temp/docdirectory/doc.d.ts:106936
Modifies the data of the tileMaps

Parameters
- _layer: undefined | number
  
  is the ID of the layer you want to edit on the SpriteMap
- pos: Vector2 | Vector2[]
  
  is the iVector2 Coordinates of the Tile
- Optional tile: number
  
  The SpriteIndex of the new Tile
Returns void

dispose Search playground for dispose

dispose(): void

Implementation of ISpriteMap.dispose
- Defined in .temp/docdirectory/doc.d.ts:106964
Release associated resources

Returns void

getMousePosition Search playground for getMousePosition

getMousePosition(): Vector2

- Defined in .temp/docdirectory/doc.d.ts:106909
Gets the UV location of the mouse over the SpriteMap.

Returns Vector2
Vector2 the UV position of the mouse interaction

getTileID Search playground for getTileID

getTileID(): Vector2

- Defined in .temp/docdirectory/doc.d.ts:106904
Returns tileID location

Returns Vector2
Vector2 the cell position ID

loadTileMaps Search playground for loadTileMaps

loadTileMaps(url: string): void

- Defined in .temp/docdirectory/doc.d.ts:106960
Imports the .tilemaps file

Parameters
- url: string
  
  of the .tilemaps file
Returns void

saveTileMaps Search playground for saveTileMaps

saveTileMaps(): void

- Defined in .temp/docdirectory/doc.d.ts:106955
Exports the .tilemaps file

Returns void