ActionContext

The fluent Action API allows you to perform "actions" on [[Actor|Actors]] such as following, moving, rotating, and more. You can implement your own actions by implementing the [[Action]] interface.

Index

Constructors

• constructor

Methods

• blink
• callMethod
• clearActions
• delay
• die
• easeBy
• easeTo
• fade
• follow
• getQueue
• meet
• moveBy
• moveTo
• repeat
• repeatForever
• rotateBy
• rotateTo
• runAction
• scaleBy
• scaleTo
• toPromise
• update

Constructors

constructor

• new ActionContext(entity: Entity<any>): ActionContext

• Parameters

  • entity: Entity<any>

  Returns ActionContext

Methods

publicblink

• blink(timeVisible: number, timeNotVisible: number, numBlinks?: number): ActionContext

• This method will cause an actor to blink (become visible and not visible). Optionally, you may specify the number of blinks. Specify the amount of time the actor should be visible per blink, and the amount of time not visible. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • timeVisible: number

    The amount of time to stay visible per blink in milliseconds

  • timeNotVisible: number

    The amount of time to stay not visible per blink in milliseconds

  • numBlinks: number = 1

    The number of times to blink

  Returns ActionContext

publiccallMethod

• callMethod(method: () => any): ActionContext

• This method allows you to call an arbitrary method as the next action in the action queue. This is useful if you want to execute code in after a specific action, i.e An actor arrives at a destination after traversing a path

  ---

  Parameters

  • method: () => any

  Returns ActionContext

publicclearActions

• clearActions(): void

• Clears all queued actions from the Actor

  ---

  Returns void

publicdelay

• delay(time: number): ActionContext

• This method will delay the next action from executing for a certain amount of time (in milliseconds). This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • time: number

    The amount of time to delay the next action in the queue from executing in milliseconds

  Returns ActionContext

publicdie

• die(): ActionContext

• This method will add an action to the queue that will remove the actor from the scene once it has completed its previous Any actions on the action queue after this action will not be executed.

  ---

  Returns ActionContext

publiceaseBy

• easeBy(offset: Vector, duration: number, easingFcn?: EasingFunction): ActionContext
• easeBy(offsetX: number, offsetY: number, duration: number, easingFcn?: EasingFunction): ActionContext

• This method will move an actor by a specified vector offset relative to the current position given a duration and a [[EasingFunction]]. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • offset: Vector

    Vector offset relative to the current position

  • duration: number

    The duration in milliseconds

  • optionaleasingFcn: EasingFunction

    Use [[EasingFunction]] or a custom function to use to calculate position, Default is [[EasingFunctions.Linear]]

  Returns ActionContext

publiceaseTo

• easeTo(pos: Vector, duration: number, easingFcn?: EasingFunction): ActionContext
• easeTo(x: number, y: number, duration: number, easingFcn?: EasingFunction): ActionContext

• This method will move an actor to the specified x and y position over the specified duration using a given [[EasingFunctions]] and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • pos: Vector

    The x,y vector location to move the actor to

  • duration: number

    The time it should take the actor to move to the new location in milliseconds

  • optionaleasingFcn: EasingFunction

    Use [[EasingFunction]] or a custom function to use to calculate position, Default is [[EasingFunctions.Linear]]

  Returns ActionContext

publicfade

• fade(opacity: number, time: number): ActionContext

• This method will cause an actor's opacity to change from its current value to the provided value by a specified time (in milliseconds). This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • opacity: number

    The ending opacity

  • time: number

    The time it should take to fade the actor (in milliseconds)

  Returns ActionContext

publicfollow

• follow(entity: Entity<any>, followDistance?: number): ActionContext

• This method will cause the entity to follow another at a specified distance

  ---

  Parameters

  • entity: Entity<any>

    The entity to follow

  • optionalfollowDistance: number

    The distance to maintain when following, if not specified the actor will follow at the current distance.

  Returns ActionContext

publicgetQueue

• getQueue(): ActionQueue

• Returns ActionQueue

publicmeet

• meet(entity: Entity<any>, speed?: number): ActionContext

• This method will cause the entity to move towards another until they collide "meet" at a specified speed.

  ---

  Parameters

  • entity: Entity<any>

    The entity to meet

  • optionalspeed: number

    The speed in pixels per second to move, if not specified it will match the speed of the other actor

  Returns ActionContext

publicmoveBy

• moveBy(offset: Vector, speed: number): ActionContext
• moveBy(xOffset: number, yOffset: number, speed: number): ActionContext

• This method will move an actor by the specified x offset and y offset from its current position, at a certain speed. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • offset: Vector

  • speed: number

    The speed in pixels per second the actor should move

  Returns ActionContext

publicmoveTo

• moveTo(pos: Vector, speed: number): ActionContext
• moveTo(x: number, y: number, speed: number): ActionContext

• This method will move an actor to the specified x and y position at the speed specified (in pixels per second) and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • pos: Vector

    The x,y vector location to move the actor to

  • speed: number

    The speed in pixels per second to move

  Returns ActionContext

publicrepeat

• repeat(repeatBuilder: (repeatContext: ActionContext) => any, times?: number): ActionContext

• This method will cause the actor to repeat all of the actions built in the repeatBuilder callback. If the number of repeats is not specified it will repeat forever. This method is part of the actor 'Action' fluent API allowing action chaining

  // Move up in a zig-zag by repeated moveBy's
  actor.actions.repeat(repeatCtx => {
  repeatCtx.moveBy(10, 0, 10);
  repeatCtx.moveBy(0, 10, 10);
  }, 5);

  ---

  Parameters

  • repeatBuilder: (repeatContext: ActionContext) => any

    The builder to specify the repeatable list of actions

  • optionaltimes: number

    The number of times to repeat all the previous actions in the action queue. If nothing is specified the actions will repeat forever

  Returns ActionContext

publicrepeatForever

• repeatForever(repeatBuilder: (repeatContext: ActionContext) => any): ActionContext

• This method will cause the actor to repeat all of the actions built in the repeatBuilder callback. If the number of repeats is not specified it will repeat forever. This method is part of the actor 'Action' fluent API allowing action chaining

  // Move up in a zig-zag by repeated moveBy's
  actor.actions.repeat(repeatCtx => {
  repeatCtx.moveBy(10, 0, 10);
  repeatCtx.moveBy(0, 10, 10);
  }, 5);

  ---

  Parameters

  • repeatBuilder: (repeatContext: ActionContext) => any

    The builder to specify the repeatable list of actions

  Returns ActionContext

publicrotateBy

• rotateBy(angleRadiansOffset: number, speed: number, rotationType?: RotationType): ActionContext

• This method will rotate an actor by the specified angle offset, from it's current rotation given a certain speed in radians/sec and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • angleRadiansOffset: number

    The angle to rotate to in radians relative to the current rotation

  • speed: number

    The speed in radians/sec the actor should rotate at

  • optionalrotationType: RotationType

    The [[RotationType]] to use for this rotation, default is shortest path

  Returns ActionContext

publicrotateTo

• rotateTo(angleRadians: number, speed: number, rotationType?: RotationType): ActionContext

• This method will rotate an actor to the specified angle at the speed specified (in radians per second) and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • angleRadians: number

    The angle to rotate to in radians

  • speed: number

    The angular velocity of the rotation specified in radians per second

  • optionalrotationType: RotationType

    The [[RotationType]] to use for this rotation

  Returns ActionContext

publicrunAction

• runAction(action: Action): ActionContext

• Parameters

  • action: Action

  Returns ActionContext

publicscaleBy

• scaleBy(offset: Vector, speed: number): ActionContext
• scaleBy(sizeOffsetX: number, sizeOffsetY: number, speed: number): ActionContext

• This method will scale an actor by an amount relative to the current scale at a certain speed in scale units/sec and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • offset: Vector

    The scaling factor to apply to the actor

  • speed: number

    The speed to scale at in scale units/sec

  Returns ActionContext

publicscaleTo

• scaleTo(size: Vector, speed: Vector): ActionContext
• scaleTo(sizeX: number, sizeY: number, speedX: number, speedY: number): ActionContext

• This method will scale an actor to the specified size at the speed specified (in magnitude increase per second) and return back the actor. This method is part of the actor 'Action' fluent API allowing action chaining.

  ---

  Parameters

  • size: Vector

    The scale to adjust the actor to over time

  • speed: Vector

    The speed of scaling specified in magnitude increase per second

  Returns ActionContext

publictoPromise

• toPromise(): Promise<void>

• Returns a promise that resolves when the current action queue up to now is finished.

  ---

  Returns Promise<void>

publicupdate

• update(elapsedMs: number): void

• Parameters

  • elapsedMs: number

  Returns void