Actor - Documentation

Constructor

new Actor($stage)

Description:

Create a new actor.

Source:

core/actor.js, line 16

Example

class ActorExample extends Actor {}

Parameters:

Name	Type	Description
`$stage`	Stage	The stage on which to create the actor.

Members

collider :Collider

Description:

Gets the collider.

Source:

core/actor.js, line 160

Gets the collider.

Type:

Collider

engine :Engine

Description:

Gets the current engine.

Source:

core/actor.js, line 170

Gets the current engine.

Type:

Engine

followers :Map.<Actor, Vector2>

Description:

Gets the followers.

Source:

core/actor.js, line 180

Gets the followers.

Type:

Map.<Actor, Vector2>

identifier :string

Description:

Gets the identifier.

Source:

core/actor.js, line 198

Gets the identifier.

Type:

string

label :string

Description:

Gets the label.

Source:

core/actor.js, line 208

Gets the label.

Type:

string

mimics :Map.<Actor, TypeMimicDeltas>

Description:

Gets the mimics.

Source:

core/actor.js, line 218

Gets the mimics.

Type:

Map.<Actor, TypeMimicDeltas>

sounds :Array.<Sound>

Description:

Gets the sounds.

Source:

core/actor.js, line 236

Gets the sounds.

Type:

Array.<Sound>

sprite :Sprite

Description:

Gets the sprite.

Source:

core/actor.js, line 246

Gets the sprite.

Type:

Sprite

stage :Stage

Description:

Gets the current stage.

Source:

core/actor.js, line 256

Gets the current stage.

Type:

Stage

translation :Vector2

Description:

Gets the position.

Source:

core/actor.js, line 266

Gets the position.

Type:

Vector2

uuid :string

Description:

Gets the uuid.

Source:

core/actor.js, line 276

Gets the uuid.

Type:

string

vibrations :Array.<Vibration>

Description:

Gets the vibrations.

Source:

core/actor.js, line 286

Gets the vibrations.

Type:

Array.<Vibration>

visible :boolean

Description:

Gets the visible status.

Source:

core/actor.js, line 296

Gets the visible status.

Type:

boolean

zIndex :number

Description:

Gets the z-index.

Source:

core/actor.js, line 306

Gets the z-index.

Type:

number

Methods

(protected) $setListener($action, $handler) → {this}

Description:

Sets an action listener.

Source:

core/actor.js, line 402

Parameters:

Name	Type	Description
`$action`	TypeGenericAction	The action to listen.
`$handler`	TypeListenerAction	The listener to set.

Returns:

Type: this

(protected) $trigger($state) → {this}

Description:

Triggers a changing state on listeners.

Source:

core/actor.js, line 451

Parameters:

Name	Type	Description
`$state`	TypeGenericState	The changing state to trigger.

Returns:

Type: this

addListener($state, $handler) → {this}

Description:

Adds a state listener.

Source:

core/actor.js, line 473

Parameters:

Name	Type	Description
`$state`	TypeGenericState	The state to listen.
`$handler`	TypeListenerState	The listener to add.

Returns:

Type: this

addSound($sound) → {this}

Description:

Adds the given sound.

Source:

core/actor.js, line 491

Parameters:

Name	Type	Description
`$sound`	Sound	The sound to add.

Returns:

Type: this

addVibration($vibration) → {this}

Description:

Adds the given vibration.

Source:

core/actor.js, line 504

Parameters:

Name	Type	Description
`$vibration`	Vibration	The vibration to add.

Returns:

Type: this

follow($actor) → {this}

Description:

Follows the position of the given actor.

Source:

core/actor.js, line 517

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to follow the position.

Returns:

Type: this

getComponent($name) → {any}

Description:

Gets a component.

Source:

core/actor.js, line 530

Parameters:

Name	Type	Description
`$name`	string	The name of the component to get.

Returns:

Type: any

hasCollider() → {boolean}

Description:

Checks if the actor has a collider.

Source:

core/actor.js, line 540

Returns:

Type: boolean

hasComponent($name) → {boolean}

Description:

Checks if the actor has the given component.

Source:

core/actor.js, line 551

Parameters:

Name	Type	Description
`$name`	string	The name of the component to check.

Returns:

Type: boolean

hasSprite() → {boolean}

Description:

Checks if the actor has a sprite.

Source:

core/actor.js, line 561

Returns:

Type: boolean

mimic($actor) → {this}

Description:

Mimics the properties of the given actor.

Source:

core/actor.js, line 572

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to mimic the properties.

Returns:

Type: this

onAfterRemove()

Description:

Called just after removing the actor.

Source:

core/actor.js, line 583

onBeforeRemove()

Description:

Called just before removing the actor.

Source:

core/actor.js, line 589

onCollide($parameters)

Description:

Called when a collision is being resolved.

Source:

core/actor.js, line 601

Parameters:

Name	Type	Description
`$parameters`	object	The given parameters.
`$parameters.$actor`	Actor	The colliding actor.
`$parameters.$east`	boolean	If the origin of collision is facing the east face.
`$parameters.$north`	boolean	If the origin of collision is facing the north face.
`$parameters.$south`	boolean	If the origin of collision is facing the south face.
`$parameters.$west`	boolean	If the origin of collision is facing the west face.

onCollideEnter($parameters)

Description:

Called when a collision is being entered.

Source:

core/actor.js, line 620

Parameters:

Name	Type	Description
`$parameters`	object	The given parameters.
`$parameters.$actor`	Actor	The colliding actor.
`$parameters.$east`	boolean	If the origin of collision is facing the east face.
`$parameters.$north`	boolean	If the origin of collision is facing the north face.
`$parameters.$south`	boolean	If the origin of collision is facing the south face.
`$parameters.$west`	boolean	If the origin of collision is facing the west face.

onCollideLeave($actor)

Description:

Called when a collision is being left.

Source:

core/actor.js, line 634

Parameters:

Name	Type	Description
`$actor`	Actor	The colliding actor.

onCreate()

Description:

Called when the actor is being created.

Source:

core/actor.js, line 643

onSetVisible($visible)

Description:

Called when the visible status is being set.

Source:

core/actor.js, line 650

Parameters:

Name	Type	Description
`$visible`	boolean	The visible status set.

onSetZIndex($zIndex)

Description:

Called when the z-index is being set.

Source:

core/actor.js, line 660

Parameters:

Name	Type	Description
`$zIndex`	number	The z-index set.

onSoundFinish($sound)

Description:

Called when a sound is finishing playing.

Source:

core/actor.js, line 670

Parameters:

Name	Type	Description
`$sound`	Sound	The sound.

onTick($timetick)

Description:

Called when the actor is being updated by one tick update.

Source:

core/actor.js, line 680

Parameters:

Name	Type	Description
`$timetick`	number	The tick duration (in ms).

onTranslate($vector)

Description:

Called when the actor is being translated.

Source:

core/actor.js, line 690

Parameters:

Name	Type	Description
`$vector`	Vector2	The translation applied.

removeCollider() → {this}

Description:

Removes the collider.

Source:

core/actor.js, line 700

Returns:

Type: this

removeComponent($name) → {this}

Description:

Removes the given component.

Source:

core/actor.js, line 713

Parameters:

Name	Type	Description
`$name`	string	The name of the component to remove.

Returns:

Type: this

removeSound($sound) → {this}

Description:

Removes the given sound.

Source:

core/actor.js, line 726

Parameters:

Name	Type	Description
`$sound`	Sound	The sound to remove.

Returns:

Type: this

removeSounds() → {this}

Description:

Removes all sound.

Source:

core/actor.js, line 738

Returns:

Type: this

removeSprite() → {this}

Description:

Removes the sprite.

Source:

core/actor.js, line 750

Returns:

Type: this

removeVibration($vibration) → {this}

Description:

Removes the given vibration.

Source:

core/actor.js, line 763

Parameters:

Name	Type	Description
`$vibration`	Vibration	The vibration to remove.

Returns:

Type: this

removeVibrations() → {this}

Description:

Removes all vibration.

Source:

core/actor.js, line 775

Returns:

Type: this

setCollider($collider) → {this}

Description:

Sets the collider.

Source:

core/actor.js, line 788

Parameters:

Name	Type	Description
`$collider`	Collider	The collider to set.

Returns:

Type: this

setComponent($name, $component) → {this}

Description:

Sets a component.

Source:

core/actor.js, line 802

Parameters:

Name	Type	Description
`$name`	string	The name of the component to set.
`$component`	any	The value of the component to set.

Returns:

Type: this

setIdentifier($identifier) → {this}

Description:

Sets the identifier.

Source:

core/actor.js, line 815

Parameters:

Name	Type	Description
`$identifier`	string	The identifier to set.

Returns:

Type: this

setLabel($label) → {this}

Description:

Sets the label.

Source:

core/actor.js, line 828

Parameters:

Name	Type	Description
`$label`	string	The label to set.

Returns:

Type: this

setSprite($sprite) → {this}

Description:

Sets the sprite.

Source:

core/actor.js, line 841

Parameters:

Name	Type	Description
`$sprite`	Sprite	The sprite to set.

Returns:

Type: this

setVisible($visible) → {this}

Description:

Sets the visible status.

Source:

core/actor.js, line 854

Parameters:

Name	Type	Description
`$visible`	boolean	The visible status to set.

Returns:

Type: this

setZIndex($zIndex) → {this}

Description:

Sets the z-index.

Source:

core/actor.js, line 881

Parameters:

Name	Type	Description
`$zIndex`	number	The z-index to set.

Returns:

Type: this

translate($vector) → {this}

Description:

Translates the actor in the world space from a third person point of view.

Source:

core/actor.js, line 908

Parameters:

Name	Type	Description
`$vector`	Vector2	The translation to apply.

Returns:

Type: this

translateTo($vector) → {this}

Description:

Translates the actor in the world space to the given position.

Source:

core/actor.js, line 923

Parameters:

Name	Type	Description
`$vector`	Vector2	The position to translate to.

Returns:

Type: this

translateX($x) → {this}

Description:

Translates the actor in the world space from a third person point of view on the x-axis.

Source:

core/actor.js, line 938

Parameters:

Name	Type	Description
`$x`	number	The translation to apply on the x-axis.

Returns:

Type: this

translateY($y) → {this}

Description:

Translates the actor in the world space from a third person point of view on the y-axis.

Source:

core/actor.js, line 953

Parameters:

Name	Type	Description
`$y`	number	The translation to apply on the y-axis.

Returns:

Type: this

trigger($action) → {this}

Description:

Triggers an action.

Source:

core/actor.js, line 968

Parameters:

Name	Type	Description
`$action`	TypeGenericAction	The action to trigger.

Returns:

Type: this

unfollow($actor) → {this}

Description:

Unfollows the position of the given actor.

Source:

core/actor.js, line 986

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to unfollow the position.

Returns:

Type: this

unmimic($actor) → {this}

Description:

Unmimics the properties of the given actor.

Source:

core/actor.js, line 999

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to unmimic the properties.

Returns:

Type: this

Type Definitions

(protected) TypeListenerAction($action)

Source:

core/actor.js, line 18

Parameters:

Name	Type	Description
`$action`	TypeGenericAction	The action to listen.

(protected) TypeListenerState($state)

Source:

core/actor.js, line 26

Parameters:

Name	Type	Description
`$state`	TypeGenericState	The state to listen.

TypeMimicDeltas

Description:

A list of relative delta properties.

Source:

core/actor.js, line 34

Properties:

Name	Type	Description
`$deltaTranslation`	Vector2	The delta translation.
`$deltaZIndex`	number	The delta z-index.

A list of relative delta properties.

Type:

object