Class BehaviorComponent

Hierarchy

Component
- BehaviorComponent

Implements

IBehaviorComponent

Index

Constructors

constructor

Properties

autoStart

Accessors

Methods

Constructors

constructor

new BehaviorComponent(): BehaviorComponent

- Defined in src/behavior/BehaviorComponent.ts:54
Returns BehaviorComponent

Properties

autoStart

autoStart: boolean = true

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

activeOperators

get activeOperators(): Operator[]

- Defined in src/behavior/BehaviorComponent.ts:39
Returns Operator[]

behavior

get behavior(): null | Behavior
set behavior(behavior: Behavior | null): void

- Defined in src/behavior/BehaviorComponent.ts:34
Returns null | Behavior
- Defined in src/behavior/BehaviorComponent.ts:35
Parameters
- behavior: Behavior | null
Returns void

customPins

get customPins(): ReferenceArray<BasePin>

- Defined in src/behavior/BehaviorComponent.ts:38
Returns ReferenceArray<BasePin>

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

version

get version(): number

- Defined in src/behavior/BehaviorComponent.ts:30
Returns number

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/behavior/BehaviorComponent.ts:78
Returns void

findPinByName

findPinByName(name: string): undefined | BasePin

- Defined in src/behavior/BehaviorComponent.ts:163
Parameters
- name: string
Returns undefined | BasePin

getPins

getPins(): ReferenceArray<BasePin>

- Defined in src/behavior/BehaviorComponent.ts:155
Returns ReferenceArray<BasePin>

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Overrides Component.isLoaded
- Defined in src/behavior/BehaviorComponent.ts:64
Returns boolean

onCollision

onCollision(info: CollisionInfo): void

- Defined in src/behavior/BehaviorComponent.ts:125
Parameters
- info: CollisionInfo
Returns void

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

onUIEvent

onUIEvent(handler: function): boolean

- Defined in src/behavior/BehaviorComponent.ts:131
Parameters
- handler: function
  - - (uiOperator: UIEvents): boolean
    - Parameters
      - uiOperator: UIEvents
      Returns boolean
Returns boolean

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

sendSignal

sendSignal(signalName: string): void

- Defined in src/behavior/BehaviorComponent.ts:138
Parameters
- signalName: string
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Inherited from Component.setEntity
- Defined in src/core/Component.ts:32
Parameters
- entity: Entity
Returns void

setPins

setPins(pins: ReferenceArray<BasePin>): void

- Defined in src/behavior/BehaviorComponent.ts:159
Parameters
- pins: ReferenceArray<BasePin>
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

start

start(): void

- Defined in src/behavior/BehaviorComponent.ts:92
Returns void

update

update(): void

- Defined in src/behavior/BehaviorComponent.ts:111
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/behavior/BehaviorComponent.ts:173
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject