Class Actor

Actor is the main entity of the game. Pretty much everything on the stage is an actor.

Index

Constructors

constructor

new Actor(config): Actor
Create an Actor
Parameters
- config: {
      appearance: AppearanceComponent | AppearanceComponent[];
      extra?: any;
      gestures?: GestureHandlers;
      movement?: MovementComponent;
      onDisappear?: ((a) => void);
      rigidBody: RigidBodyComponent;
      role?: RoleComponent;
      sounds?: SoundEffectComponent;
  }
  - appearance: AppearanceComponent | AppearanceComponent[]
    The appearance of the actor
  - Optional extra?: any
    An untyped object to store extra information
  - Optional gestures?: GestureHandlers
    Any gestures to attach to this actor
  - Optional movement?: MovementComponent
    The movement rules for this actor
  - Optional onDisappear?: ((a) => void)
    Code to run when the actor disappears
    - (a): void
      Code to run when the actor disappears
      
      Parameters
      a: Actor
      Returns void
  - rigidBody: RigidBodyComponent
    The actor's body
  - Optional role?: RoleComponent
    The role for this actor
  - Optional sounds?: SoundEffectComponent
    The sounds for this actor
Returns Actor
- Defined in Entities/Actor.ts:57

Properties

`Readonly` appearance

appearance: AppearanceComponent[]

The visual representation of this Actor within the game

`Readonly` extra

extra: any = {}

Extra data that the game designer can attach to the Actor

gestures

gestures: GestureHandlers

A set of functions describing how the Actor should respond to gestures.

`Readonly` movement

movement: MovementComponent

The rules for how this Actor should move

`Readonly` onDisappear

onDisappear: undefined | ((a) => void)

Code to run when the actor disappears

Type declaration

- (a): void
- Parameters
  - a: Actor
  Returns void

`Readonly` rigidBody

rigidBody: RigidBodyComponent

A physical context for the Actor. This is necessary if the Actor will move, participate in collisions, or receive gesture inputs.

`Readonly` role

role: RoleComponent

The behavioral role that this Actor plays within the game

scene

scene: Scene

The scene where the Actor exists

`Readonly` sounds

sounds: SoundEffectComponent

The packet of information describing the audio aspects of this Actor

`Readonly` state

state: StateManagerComponent = ...

The current state of this Actor

Accessors

enabled

get enabled(): boolean
Returns boolean
- Defined in Entities/Actor.ts:17
set enabled(val): void
Is this Actor visible and able to interact with the world?
Parameters
- val: boolean
Returns void
- Defined in Entities/Actor.ts:16

Methods

prerender

prerender(elapsedMs): boolean
Prerender is called on an Actor immediately before it is rendered. This lets us do any last-minute adjustments before putting it on the screen.
Parameters
- elapsedMs: number
  The time since the last render
Returns boolean
True if the Actor is enabled, false otherwise
- Defined in Entities/Actor.ts:101

remove

remove(): void
Make an Actor disappear

Returns void
- Defined in Entities/Actor.ts:112

resize

resize(scale): void
Change the size of an Actor, keeping its center unchanged
Parameters
- scale: number
  The factor by which to scale the actor's dimensions. Must be >0. 1 means no change, a fraction means shrink, and a number >1 means grow.
Returns void
- Defined in Entities/Actor.ts:135

Class Actor

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: { appearance: AppearanceComponent | AppearanceComponent[]; extra?: any; gestures?: GestureHandlers; movement?: MovementComponent; onDisappear?: ((a) => void); rigidBody: RigidBodyComponent; role?: RoleComponent; sounds?: SoundEffectComponent; }

appearance: AppearanceComponent | AppearanceComponent[]

Optional extra?: any

Optional gestures?: GestureHandlers

Optional movement?: MovementComponent

Optional onDisappear?: ((a) => void)

Parameters

a: Actor

Returns void

rigidBody: RigidBodyComponent

Optional role?: RoleComponent

Optional sounds?: SoundEffectComponent

Returns Actor

Properties

Readonly appearance

Readonly extra

gestures

Readonly movement

Readonly onDisappear

Type declaration

Parameters

a: Actor

Returns void

Readonly rigidBody

Readonly role

scene

Readonly sounds

Readonly state

Accessors

enabled

Returns boolean

Parameters

val: boolean

Returns void

Methods

prerender

Parameters

elapsedMs: number

Returns boolean

remove

Returns void

resize

Parameters

scale: number

Returns void

Settings

Member Visibility

Theme

On This Page

config: {
appearance: AppearanceComponent | AppearanceComponent[];
extra?: any;
gestures?: GestureHandlers;
movement?: MovementComponent;
onDisappear?: ((a) => void);
rigidBody: RigidBodyComponent;
role?: RoleComponent;
sounds?: SoundEffectComponent;
}

`Optional` extra?: any

`Optional` gestures?: GestureHandlers

`Optional` movement?: MovementComponent

`Optional` onDisappear?: ((a) => void)

`Optional` role?: RoleComponent

`Optional` sounds?: SoundEffectComponent

`Readonly` appearance

`Readonly` extra

`Readonly` movement

`Readonly` onDisappear

`Readonly` rigidBody

`Readonly` role

`Readonly` sounds

`Readonly` state