Class Actions

Actions are used to execute methods across all connected devices.

Hierarchy

  • Actions

Index

Methods

  • DeregisterAction
  • ExecuteAction
  • GetActionList
  • RegisterAction

Methods

Static DeregisterAction

DeregisterAction(name: string): void
  • Defined in TableRealms.ts:229
  • Removes a callback registered to the name.

Parameters

  • name: string
    • The name of the registered callback.

Returns void

Static ExecuteAction

ExecuteAction(name: string, params: any): void
  • Defined in TableRealms.ts:236
  • Executes a callback registered to the name.

Parameters

  • name: string
  • params: any
    • Any parameters the callback expects.

Returns void

Static GetActionList

GetActionList(): string[]
  • Defined in TableRealms.ts:241
    • Returns a list of registered action names.
    • Returns string[]

Static RegisterAction

RegisterAction(name: string, callback: function): void
  • Defined in TableRealms.ts:222
  • Registers an action which can be called from a game that has the Context of Host.
  • There can only be one callback registered per name.

Parameters

  • name: string
    • The name of the registered callback.
  • callback: function
    • The void that is called based on the registered name.
  • (params: any): void

Parameters

  • params: any
    • Returns void
    • Returns void