EngineVariableBinding | @acaengine/ts-client

Hierarchy

EngineVariableBinding

Index

Constructors

constructor

Properties

name

Accessors

count
value

Methods

Constructors

constructor

new EngineVariableBinding(_service: EngineBindingService, _module: EngineModuleBinding, _name: string): EngineVariableBinding

- Defined in websocket/classes/engine-status-variable.class.ts:12
Parameters
- _service: EngineBindingService
- _module: EngineModuleBinding
- _name: string
Returns EngineVariableBinding

Properties

name

name: string

Status variable name

Accessors

count

get count(): number

- Defined in websocket/classes/engine-status-variable.class.ts:33
Number of bindings to this status variable

Returns number

value

get value(): any

- Defined in websocket/classes/engine-status-variable.class.ts:38
Current value of the binding

Returns any

Methods

bind

bind(): () => void

- Defined in websocket/classes/engine-status-variable.class.ts:53
Bind to the status variable's value

Returns () => void
- - (): void
  - Returns void

listen

listen(next: (_: any) => void): Subscription

- Defined in websocket/classes/engine-status-variable.class.ts:46
Subscribe to changes of the variable's binding value

Parameters
- next: (_: any) => void
  
  Callback for changes to the bindings value
  - - (_: any): void
    - Parameters
      - _: any
      Returns void
Returns Subscription

unbind

unbind(): void

- Defined in websocket/classes/engine-status-variable.class.ts:66
Unbind from status variable

Returns void

Generated using TypeDoc