Class: RepeatAction

The Action class has static methods for creating actions to be executed by an M2Node.

Extends

• Action

Extended by

• RepeatForeverAction

Implements

• RepeatingActionContainer

Constructors

new RepeatAction()

new RepeatAction(action, count, runDuringTransition): RepeatAction

Parameters

• action: Action

• count: number

• runDuringTransition: boolean= false

Returns

RepeatAction

Overrides

Action.constructor

Source

Action.ts:1020

Properties

children

children: Action[]

Implementation of

RepeatingActionContainer.children

Source

Action.ts:1016

---

completedRepetitions

completedRepetitions: number = 0

Implementation of

RepeatingActionContainer.completedRepetitions

Source

Action.ts:1017

---

count

count: number

Implementation of

RepeatingActionContainer.count

Source

Action.ts:1015

---

cumulativeDuration

cumulativeDuration: number = 0

Implementation of

RepeatingActionContainer.cumulativeDuration

Source

Action.ts:1018

---

duration

duration: Futurable

Implementation of

RepeatingActionContainer.duration

Inherited from

Action.duration

Source

Action.ts:38

---

key?

optional key: string

Implementation of

RepeatingActionContainer.key

Inherited from

Action.key

Source

Action.ts:41

---

parent?

optional parent: ActionContainer

Implementation of

RepeatingActionContainer.parent

Inherited from

Action.parent

Source

Action.ts:40

---

runDuringTransition

runDuringTransition: boolean

Implementation of

RepeatingActionContainer.runDuringTransition

Inherited from

Action.runDuringTransition

Source

Action.ts:39

---

runStartTime

runStartTime: number = -1

Start time of a running action is always known; it is not a Futurable. -1 indicates that the root action has not yet started running.

Implementation of

RepeatingActionContainer.runStartTime

Inherited from

Action.runStartTime

Source

Action.ts:37

---

running

running: boolean = false

Implementation of

RepeatingActionContainer.running

Inherited from

Action.running

Source

Action.ts:31

---

startOffset

startOffset: Futurable

Implementation of

RepeatingActionContainer.startOffset

Inherited from

Action.startOffset

Source

Action.ts:29

---

started

started: boolean = false

Implementation of

RepeatingActionContainer.started

Inherited from

Action.started

Source

Action.ts:30

---

type

type: ActionType = ActionType.Repeat

Implementation of

RepeatingActionContainer.type

Overrides

Action.type

Source

Action.ts:1014

Accessors

completed

get completed(): boolean

Indicates whether the action has completed, taking into account all its child actions and the number of repetitions.

Remarks

Is read-only for parent actions.

Returns

boolean

Source

Action.ts:1049

---

descendants

get descendants(): Action[]

Returns

Action[]

Source

Action.ts:1082

---

descendantsAreCompleted

get descendantsAreCompleted(): boolean

Returns

boolean

Source

Action.ts:1056

---

repetitionHasCompleted

get repetitionHasCompleted(): boolean

Indicates whether a single repetition of a repeating action has just completed.

Returns

boolean

returns true if a repetition has completed

Source

Action.ts:1066

Methods

assignRunStartTimes()

assignRunStartTimes(action, runStartTime): void

Assigns RunStartTime to all actions in the hierarchy.

Parameters

• action: Action

the action to assign RunStartTime to

• runStartTime: number

Returns

void

Implementation of

RepeatingActionContainer.assignRunStartTimes

Inherited from

Action.assignRunStartTimes

Remarks

Uses recursion to handle arbitrary level of nesting parent actions within parent actions.

Source

Action.ts:647

---

clone()

clone(): RepeatAction

Clones the action, and any actions it contains, recursively.

Returns

RepeatAction

a clone of the action

Implementation of

RepeatingActionContainer.clone

Overrides

Action.clone

Remarks

We need to clone an action before running it because actions have state that is updated over time such as whether they are running or not, etc. If we didn't clone actions, two nodes reusing the same action would share state. On Action, this method is abstract and is implemented in each subclass.

Source

Action.ts:1027

---

initialize()

initialize(key?): Action

Prepares the Action for evaluation.

Parameters

• key?: string

optional string to identify an action

Returns

Action

action prepared for evaluation

Implementation of

RepeatingActionContainer.initialize

Inherited from

Action.initialize

Remarks

Calculates start times for all actions in the hierarchy and returns a copy of the action that is prepared for evaluation during the update loop.

Source

Action.ts:57

---

isParent()

isParent(action): action is ActionContainer

Type guard that returns true if the action is a parent action.

Parameters

• action: Action

action to check

Returns

action is ActionContainer

true if the action is a parent action

Implementation of

RepeatingActionContainer.isParent

Inherited from

Action.isParent

Remarks

Parent actions are Group, Sequence, Repeat, and RepeatForever actions.

Source

Action.ts:910

---

restartAction()

restartAction(action, now): void

Configures action to be run again.

Parameters

• action: Action

action to restart

• now: number

current time

Returns

void

Implementation of

RepeatingActionContainer.restartAction

Inherited from

Action.restartAction

Remarks

This method is called on a repeating action's children when they need to be run again.

Source

Action.ts:665

---

shouldBeRunning()

shouldBeRunning(now): boolean

Determines if the action should be running.

Parameters

• now: number

current time

Returns

boolean

true if the action should be running

Implementation of

RepeatingActionContainer.shouldBeRunning

Inherited from

Action.shouldBeRunning

Remarks

An action should be running if current time is in the interval [ start time + start offset, start time + start offset + duration ]

Source

Action.ts:704

---

custom()

static custom(options): CustomAction

Creates an action that will execute a callback function.

Parameters

• options: CustomActionOptions

CustomActionOptions

Returns

CustomAction

The custom action

Inherited from

Action.custom

Source

Action.ts:746

---

evaluateAction()

static evaluateAction(action, node, now, dt): void

Evaluates an action, updating the node's properties as needed.

Parameters

• action: Action

the Action to be evaluated and possibly run

• node: M2Node

the M2Node that the action will be run on

• now: number

the current elapsed time, from performance.now()

• dt: number

the time since the last frame (delta time)

Returns

void

Inherited from

Action.evaluateAction

Remarks

This method is called every frame by the M2Node's update() method.

Source

Action.ts:279

---

fadeAlpha()

static fadeAlpha(options): FadeAlphaAction

Creates an action that will change the node's alpha (opacity).

Parameters

• options: FadeAlphaActionOptions

FadeAlphaActionOptions

Returns

FadeAlphaAction

The fadeAlpha action

Inherited from

Action.fadeAlpha

Remarks

Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's action fades alpha to .4, then the node will appear with alpha .2.

Source

Action.ts:795

---

group()

static group(actions): GroupAction

Create an array of actions that will be run simultaneously.

Parameters

• actions: Action[]

One or more actions that form the group

Returns

GroupAction

Inherited from

Action.group

Remarks

All actions within the group will begin to run at the same time. The group will be considered completed when the longest-running action has completed.

Source

Action.ts:868

---

move()

static move(options): MoveAction

Creates an action that will move a node to a point on the screen.

Parameters

• options: MoveActionOptions

MoveActionOptions

Returns

MoveAction

The move action

Inherited from

Action.move

Source

Action.ts:717

---

play()

static play(options?): PlayAction

Creates an action that will play a sound.

Parameters

• options?: PlayActionOptions

PlayActionOptions

Returns

PlayAction

The play action

Inherited from

Action.play

Remarks

This action can only be used with a SoundPlayer node. It will throw an error if used with any other node type.

Source

Action.ts:762

---

repeat()

static repeat(options): RepeatAction

Creates an action that will repeat another action a given number of times.

Parameters

• options: RepeatActionOptions

RepeatActionOptions

Returns

RepeatAction

The repeat action

Inherited from

Action.repeat

Source

Action.ts:880

---

repeatForever()

static repeatForever(options): RepeatForeverAction

Creates an action that will repeat another action forever.

Parameters

• options: RepeatForeverActionOptions

RepeatForeverActionOptions

Returns

RepeatForeverAction

The repeat forever action

Inherited from

Action.repeatForever

Remarks

A repeat forever action is a special case of a repeat action where the count is set to infinity.

Source

Action.ts:897

---

rotate()

static rotate(options): RotateAction

Creates an action that will rotate the node.

Parameters

• options: RotateActionOptions

RotateActionOptions

Returns

RotateAction

The rotate action

Inherited from

Action.rotate

Remarks

Rotate actions are applied to their children. In addition to this node's rotate action, all ancestors' rotate actions will also be applied.

Source

Action.ts:812

---

scale()

static scale(options): ScaleAction

Creates an action that will scale the node's size.

Parameters

• options: ScaleActionOptions

ScaleActionOptions

Returns

ScaleAction

The scale action

Inherited from

Action.scale

Remarks

Scaling is relative to any inherited scaling, which is multiplicative. For example, if the node's parent is scaled to 2.0 and this node's action scales to 3.0, then the node will appear 6 times as large as original.

Source

Action.ts:777

---

sequence()

static sequence(actions): SequenceAction

Creates an array of actions that will be run in order.

Parameters

• actions: Action[]

One or more actions that form the sequence

Returns

SequenceAction

Inherited from

Action.sequence

Remarks

The next action will not begin until the current one has finished. The sequence will be considered completed when the last action has completed.

Source

Action.ts:852

---

wait()

static wait(options): WaitAction

Creates an action that will wait a given duration before it is considered complete.

Parameters

• options: WaitActionOptions

WaitActionOptions

Returns

WaitAction

The wait action

Inherited from

Action.wait

Source

Action.ts:733