Type Alias RoomStateEvents

RoomStateEvents: {
    hintCostUpdated: [oldCost: number, newCost: number, oldPercentage: number, newPercentage: number];
    hintPointsUpdated: [oldValue: number, newValue: number];
    locationCheckPointsUpdated: [oldValue: number, newValue: number];
    locationsChecked: [locations: number[]];
    passwordUpdated: [password: boolean];
    permissionsUpdated: [oldValue: PermissionTable, newValue: PermissionTable];
}

An interface with all supported room events and their respective callback arguments. To be called from RoomStateManager.

Type declaration

  • hintCostUpdated: [oldCost: number, newCost: number, oldPercentage: number, newPercentage: number]

    Fires when the hint cost has been updated.

    Param: oldCost

    The previous amount of hint points required to request a hint.

    Param: newCost

    The new amount of hint points required to request a hint.

    Param: oldPercentage

    The old hint cost percentage.

    Param: newPercentage

    The new hint cost percentage.

  • hintPointsUpdated: [oldValue: number, newValue: number]

    Fires when the player's hint points value has updated.

    Param: oldValue

    The old hint point value.

    Param: newValue

    The new hint point value.

  • locationCheckPointsUpdated: [oldValue: number, newValue: number]

    Fires when the location check points have been updated.

    Param: oldValue

    The previous location check points value.

    Param: newValue

    The new location check points value.

  • locationsChecked: [locations: number[]]

    Fires when new locations have been checked (or all locations on initial connection).

    Param: locations

    All the newly checked locations.

  • passwordUpdated: [password: boolean]

    Fires when the room password has been toggled.

    Param: password

    If the room now requires a password to join.

  • permissionsUpdated: [oldValue: PermissionTable, newValue: PermissionTable]

    Fires when command permissions have been updated.

    Param: oldValue

    The previous command permissions table.

    Param: newValue

    The new command permissions table.

Settings

Member Visibility