Class Player

Contains all TableRealms player specific information. A list of connected players can be fetched from {@link TableRealmsTiny.Players.GetPlayerList()}

Hierarchy

  • Player

Index

Constructors

  • constructor

Properties

  • id

Methods

  • GetButtonEnabled
  • GetButtonPressed
  • GetData
  • GetThumbstickAR
  • GetThumbstickXY
  • SetData
  • SetPage

Constructors

constructor

new Player(id: string): Player
  • Defined in Player.ts:12

Parameters

  • id: string
    • Returns Player

Properties

id

  • id: string
    • Defined in Player.ts:12

Methods

GetButtonEnabled

GetButtonEnabled(name: string): Object
  • Defined in Player.ts:52
    • Check a player specific button’s enabled state

Parameters

  • name: string
    • Returns Object

GetButtonPressed

GetButtonPressed(name: string): Object
  • Defined in Player.ts:57
    • Check a player specific button’s pressed state

Parameters

  • name: string
    • Returns Object

GetData

GetData<T>(key: string): T
  • Defined in Player.ts:20
    • Gets player specific data.
    • Shorthand for TableRealmsTiny.Model.GetData(playerId +'.'+ key);

Type parameters

T

Parameters

  • key: string
    • Returns T

GetThumbstickAR

GetThumbstickAR(name: string): Vector2*
  • Defined in Player.ts:42
    • Gets player specific thumbstick as a vector with angle A and radius R.

Parameters

  • name: string
    • Returns Vector2

GetThumbstickXY

GetThumbstickXY(name: string): Vector2
  • Defined in Player.ts:32
    • Gets player specific thumbstick as a vector with normilized X and Y.

Parameters

  • name: string
    • Returns Vector2

SetData

SetData<T>(key: string, value: T, forceUpdate: boolean): void
  • Defined in Player.ts:27
    • Sets player specific data. Shorthand for TableRealmsTiny.Model.SetData(playerId +‘.’+ key, value, forceUpdate);

Type parameters

T

Parameters

  • key: string
  • value: T
  • forceUpdate: boolean
    • Returns void

SetPage

SetPage(page: string): void
  • Defined in Player.ts:64
    • Sets a player’s page

Parameters

  • page: string
    • The name of the new page that will be displayed.
    • Returns void