Class: Spritesheet

Name	Description	Arguments
load	Spritesheet is fully loaded and ready to use	None
add	Spritesheet is added to the renderer	None
delete	Spritesheet is removed from the renderer	None

Constructor

new Spritesheet(options)

Creates a new Spritesheet

Parameters:

Name	Type	Description
`options`	Object	Spritesheet options

Source: render/Spritesheet.js, line 17

Example

// Includes all Spritesheet options
new Spritesheet({
	container: game.Render.app.stage, // PIXI Container
	layer: 0,
	position: new vec(0, 0),
	angle: 0,

	visible: true,
	alpha: 1,
	speed: 1 / 6,
	src: "",
	animation: "",
	
	scale: new vec(1, 1),
	width:  undefined, // Number | undefined
	height: undefined, // Number | undefined
});

Extends

Node

Members

(readonly) nodeType

Type of node, ie Node or RigidBody

Overrides: Node#nodeType
Source: node/Node.js, line 28

(readonly) position :vec

Position of the node

Type:

Overrides: Node#position
Source: node/Node.js, line 36
To Do: Implement getPosition method and make this private

(readonly) angle :number

Angle, in radians

Type:

number

Overrides: Node#angle
Source: node/Node.js, line 43
To Do: Implement getAngle method and make this private

(readonly) children :Set

Children of the node To modify, use addChild or removeChild.

Type:

Overrides: Node#children
Source: node/Node.js, line 50

Methods

add()

Adds the sprite to the world

Overrides: Node#add
Source: render/Spritesheet.js, line 111

delete()

Removes the sprite from the world

Overrides: Node#delete
Source: render/Spritesheet.js, line 125

setSpeed(speed)

Sets the animation's speed

Parameters:

Name	Type	Description
`speed`	Number

Source: render/Spritesheet.js, line 138

setLayer(layer)

Sets the render layer (z index)

Parameters:

Name	Type	Description
`layer`	number	Render layer (z index) for the render

Source: render/Spritesheet.js, line 147

setScale(scale)

Sets the sprite's scale

Parameters:

Name	Type	Description
`scale`	vec	New scale

Source: render/Spritesheet.js, line 157

setSize(width, height)

Sets the sprite's width and height

Parameters:

Name	Type	Description
`width`	number	New width
`height`	number	New height

Source: render/Spritesheet.js, line 171

setAlpha(alpha)

Sets the sprite's alpha

Parameters:

Name	Type	Description
`alpha`	number	Opacity, between 0 and 1 inclusive

Source: render/Spritesheet.js, line 185

setVisible(visible)

Changes if the sprite is visible

Parameters:

Name	Type	Description
`visible`	boolean	If the sprite is visible

Source: render/Spritesheet.js, line 195

translate(delta)

Shifts the sprite's position by delta

Parameters:

Name	Type	Description
`delta`	vec	Amount sprite is shifted by

Overrides: Node#translate
Source: render/Spritesheet.js, line 205

translateAngle(angle)

Rotates the sprite relative to current angle

Parameters:

Name	Type	Description
`angle`	number	Amount to rotate sprite, in radians

Overrides: Node#translateAngle
Source: render/Spritesheet.js, line 218

destroy()

Destroys the sprite. Use when you know the sprite will no longer be used

Source: render/Spritesheet.js, line 229

on(event, callback)

Binds a function to an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event
`callback`	function	Function called when event fires

Overrides: Node#on
Source: render/Spritesheet.js, line 244

off(event, callback)

Unbinds a function from an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event
`callback`	function	Function bound to event

Overrides: Node#off
Source: render/Spritesheet.js, line 257

trigger(event)

Fires an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event

Overrides: Node#trigger
Source: render/Spritesheet.js, line 267

isAdded() → {Boolean}

Gets if the node is added

Overrides: Node#isAdded
Source: node/Node.js, line 101

Returns:

if the node is added

Type:: Boolean

addChild(…children)

Adds all children to this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children added

Overrides: Node#addChild
Source: node/Node.js, line 113

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode);

removeChild(…children)

Removes all children from this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children removed

Overrides: Node#removeChild
Source: node/Node.js, line 127

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode); // node.children: Set {childNode}
node.removeChild(childNode); // node.children: Set {}

setPosition(position)

Sets this node's position to position

Parameters:

Name	Type	Description
`position`	vec	Position the node should be set to

Overrides: Node#setPosition
Source: node/Node.js, line 139

Example

node.setPosition(new vec(100, 100)); // Sets node's position to (100, 100)

setAngle(angle)

Sets the node's angle to angle

Parameters:

Name	Type	Description
`angle`	number	Angle body should be in radians

Overrides: Node#setAngle
Source: node/Node.js, line 162

Example

node.setAngle(Math.PI); // Sets node's angle to Pi radians, or 180 degrees