pencil.js / sprite / Spritesheet

Class: Spritesheet

Defined in: sprite.ts:263

Loaded spritesheet, able to extract sprites

Constructors

Constructor

new Spritesheet(json): Spritesheet;

Defined in: sprite.ts:271

Spritesheet constructor

Parameters

Parameter	Type	Description
json	SpritesheetData	JSON description with loaded image

Returns

Spritesheet

Properties

Property	Type	Description	Defined in
json	SpritesheetData	JSON description	sprite.ts:265

Accessors

file

Get Signature

get file(): HTMLImageElement | undefined;

Defined in: sprite.ts:278

Loaded image

Returns

HTMLImageElement | undefined

Methods

extract()

extract(
   position?, 
   selector?, 
   options?
): Sprite;

Defined in: sprite.ts:300

Create a sprite with all frames matching a selector

Parameters

Parameter	Type	Description
position?	PositionDefinition	Position of the sprite
selector?	FrameSelector	Glob pattern, regular expression or filter function
options?	Partial<SpriteOptions>	Sprite options

Returns

Sprite

---

get()

get(selector?): FrameData[];

Defined in: sprite.ts:286

Return all frames matching a selector

Parameters

Parameter	Type	Default value	Description
selector?	FrameSelector	"*"	Glob pattern, regular expression or filter function

Returns

FrameData[]