Class Sprite

A Sprite contains references to one or more frames of a TextureAtlas. It can be used by the SpriteComponent or the ElementComponent to render a single frame or a sprite animation.

Hierarchy (View Summary)

EventHandler
- Sprite

Index

Constructors

constructor

new Sprite(
    device: GraphicsDevice,
    options?: {
        atlas?: TextureAtlas;
        frameKeys?: string[];
        pixelsPerUnit?: number;
        renderMode?: number;
    },
): Sprite
Create a new Sprite instance.
Parameters
- device: GraphicsDevice
  The graphics device of the application.
- Optionaloptions: {
      atlas?: TextureAtlas;
      frameKeys?: string[];
      pixelsPerUnit?: number;
      renderMode?: number;
  }
  Options for creating the Sprite.
  - Optionalatlas?: TextureAtlas
    The texture atlas. Defaults to null.
  - OptionalframeKeys?: string[]
    The keys of the frames in the sprite atlas that this sprite is using. Defaults to null.
  - OptionalpixelsPerUnit?: number
    The number of pixels that map to one PlayCanvas unit. Defaults to 1.
  - OptionalrenderMode?: number
    The rendering mode of the sprite. Can be:
    
    SPRITE_RENDERMODE_SIMPLE
    
    SPRITE_RENDERMODE_SLICED
    
    SPRITE_RENDERMODE_TILED
    
    Defaults to SPRITE_RENDERMODE_SIMPLE.
Returns Sprite
Overrides EventHandler.constructor
- Defined in src/scene/sprite.js:52

Accessors

atlas

get atlas(): TextureAtlas
Gets the texture atlas.

Returns TextureAtlas
- Defined in src/scene/sprite.js:136
set atlas(value: TextureAtlas): void
Sets the texture atlas.
Parameters
- value: TextureAtlas
Returns void
- Defined in src/scene/sprite.js:106

frameKeys

get frameKeys(): string[]
Gets the keys of the frames in the sprite atlas that this sprite is using.

Returns string[]
- Defined in src/scene/sprite.js:97
set frameKeys(value: string[]): void
Sets the keys of the frames in the sprite atlas that this sprite is using.
Parameters
- value: string[]
Returns void
- Defined in src/scene/sprite.js:78

meshes

get meshes(): Mesh[]
An array that contains a mesh for each frame.

Returns Mesh[]
- Defined in src/scene/sprite.js:214

pixelsPerUnit

get pixelsPerUnit(): number
Gets the number of pixels that map to one PlayCanvas unit.

Returns number
- Defined in src/scene/sprite.js:166
set pixelsPerUnit(value: number): void
Sets the number of pixels that map to one PlayCanvas unit.
Parameters
- value: number
Returns void
- Defined in src/scene/sprite.js:145

renderMode

get renderMode(): number
Sets the rendering mode of the sprite.

Returns number
- Defined in src/scene/sprite.js:205
set renderMode(value: number): void
Sets the rendering mode of the sprite. Can be:
Parameters
- value: number
Returns void
- Defined in src/scene/sprite.js:179

Methods

destroy

destroy(): void
Free up the meshes created by the sprite.

Returns void
- Defined in src/scene/sprite.js:390

fire

fire(
    name: string,
    arg1?: any,
    arg2?: any,
    arg3?: any,
    arg4?: any,
    arg5?: any,
    arg6?: any,
    arg7?: any,
    arg8?: any,
): EventHandler
Fire an event, all additional arguments are passed on to the event listener.
Parameters
- name: string
  Name of event to fire.
- Optionalarg1: any
  First argument that is passed to the event handler.
- Optionalarg2: any
  Second argument that is passed to the event handler.
- Optionalarg3: any
  Third argument that is passed to the event handler.
- Optionalarg4: any
  Fourth argument that is passed to the event handler.
- Optionalarg5: any
  Fifth argument that is passed to the event handler.
- Optionalarg6: any
  Sixth argument that is passed to the event handler.
- Optionalarg7: any
  Seventh argument that is passed to the event handler.
- Optionalarg8: any
  Eighth argument that is passed to the event handler.
Returns EventHandler
Self for chaining.
Example
```
obj.fire('test', 'This is the message');
```
Inherited from EventHandler.fire
- Defined in src/core/event-handler.js:274

hasEvent

hasEvent(name: string): boolean
Test if there are any handlers bound to an event name.
Parameters
- name: string
  The name of the event to test.
Returns boolean
True if the object has handlers bound to the specified event name.
Example
```
obj.on('test', () => {}); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
```
Inherited from EventHandler.hasEvent
- Defined in src/core/event-handler.js:342

off

off(name?: string, callback?: HandleEventCallback, scope?: any): EventHandler
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Parameters
- Optionalname: string
  Name of the event to unbind.
- Optionalcallback: HandleEventCallback
  Function to be unbound.
- Optionalscope: any
  Scope that was used as the this when the event is fired.
Returns EventHandler
Self for chaining.
Example
```
const handler = () => {};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
```
Inherited from EventHandler.off
- Defined in src/core/event-handler.js:154

on

on(name: string, callback: HandleEventCallback, scope?: any): EventHandle
Attach an event handler to an event.
Parameters
- name: string
  Name of the event to bind the callback to.
- callback: HandleEventCallback
  Function that is called when event is fired. Note the callback is limited to 8 arguments.
- Optionalscope: any = ...
  Object to use as 'this' when the event is fired, defaults to current this.
Returns EventHandle
Can be used for removing event in the future.
Example
```
obj.on('test', (a, b) => {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
```
Example
```
const evt = obj.on('test', (a, b) => {
    console.log(a + b);
});
// some time later
evt.off();
```
Inherited from EventHandler.on
- Defined in src/core/event-handler.js:112

once

once(name: string, callback: HandleEventCallback, scope?: any): EventHandle
Attach an event handler to an event. This handler will be removed after being fired once.
Parameters
- name: string
  Name of the event to bind the callback to.
- callback: HandleEventCallback
  Function that is called when event is fired. Note the callback is limited to 8 arguments.
- Optionalscope: any = ...
  Object to use as 'this' when the event is fired, defaults to current this.
Returns EventHandle
- can be used for removing event in the future.
Example
```
obj.once('test', (a, b) => {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
```
Inherited from EventHandler.once
- Defined in src/core/event-handler.js:132

Class Sprite

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optionalatlas?: TextureAtlas

OptionalframeKeys?: string[]

OptionalpixelsPerUnit?: number

OptionalrenderMode?: number

Returns Sprite

Accessors

atlas

Returns TextureAtlas

Parameters

Returns void

frameKeys

Returns string[]

Parameters

Returns void

meshes

Returns Mesh[]

pixelsPerUnit

Returns number

Parameters

Returns void

renderMode

Returns number

Parameters

Returns void

Methods

destroy

Returns void

fire

Parameters

Returns EventHandler

Example

hasEvent

Parameters

Returns boolean

Example

off

Parameters

Returns EventHandler

Example

on

Parameters

Returns EventHandle

Example

Example

once

Parameters

Returns EventHandle

Example

Settings

On This Page

`Optional`atlas?: TextureAtlas

`Optional`frameKeys?: string[]

`Optional`pixelsPerUnit?: number

`Optional`renderMode?: number