Class RepeatBehavior

Hierarchy (view full)

AbstractDecoratorBehavior
- RepeatBehavior

Index

Constructors

Properties

__iterator __source context isBehavior limit onFinalized onInitialized typeName

Methods

finalize getCount getSource initialize setCount setSource tick from

Constructors

constructor

new RepeatBehavior(source, count?): RepeatBehavior
Parameters
- source: Behavior
- Optional count: number = Infinity
Returns RepeatBehavior
Overrides AbstractDecoratorBehavior.constructor

Properties

`Protected` __iterator

__iterator: number

`Protected` __source

__source: Behavior

context

context: BehaviorContext = null

Any internal state used by the behavior This provides a way to interact with the outside as well as to pass data between themselves

isBehavior

isBehavior: boolean

limit

limit: number

`Readonly` onFinalized

onFinalized: Signal = ...

Dispatched after finalization is complete

`Readonly` onInitialized

onInitialized: Signal = ...

Dispatched after initialization is complete

typeName

typeName: string

Methods

finalize

finalize(): void
Called when behavior is finished, or interrupted Used to clean up any resources You can think of it as "stop"

Returns void
Inherited from AbstractDecoratorBehavior.finalize

getCount

getCount(): number
Returns number
Deprecated
use .limit directly instead

getSource

getSource(): Behavior
Returns Behavior
Inherited from AbstractDecoratorBehavior.getSource

initialize

initialize(context): void
Called before behavior gets executed via tick for the first time Used to prepare the behavior for execution You can think of it as "start"
Parameters
- context: BehaviorContext
Returns void
Overrides AbstractDecoratorBehavior.initialize

setCount

setCount(v): void
Parameters
- v: number
Returns void
Deprecated
use .limit directly instead

setSource

setSource(source): void
Parameters
- source: Behavior
Returns void
Inherited from AbstractDecoratorBehavior.setSource

tick

tick(timeDelta): Initial | Running | Succeeded | Suspended | Invalid
Main update function. Every behavior executes some logic, some behaviors are long-running and some are instantaneous
Parameters
- timeDelta: number
  time step in seconds
Returns Initial | Running | Succeeded | Suspended | Invalid
signals status of the behavior, "success" or "failure" are used to signal completion of the behavior

Overrides AbstractDecoratorBehavior.tick

`Static` from

from(source, count?): RepeatBehavior
Parameters
- source: Behavior
- Optional count: number = Infinity
Returns RepeatBehavior