Class RoomFixedUpdateEvent<RoomType>

Emitted when the room completes a fixed update cycle. (Roughly 20ms)

Note that this is called very often, and if the event takes too longer, that is, too long so that the next fixed update is called before it has finished, then it will cascade and eventually crash due to a memory leak.

Type Parameters

Hierarchy

  • CancelableEvent
    • RoomFixedUpdateEvent

Implements

Properties

Methods

Constructors

Properties

eventName: "room.fixedupdate"
canceled: boolean
delta: number

The time that has passed since the last fixed update call, in seconds.

eventName: "room.fixedupdate"
room: RoomType

The room or client that the event came from.

The game data stream that the room will broadcast.

Methods

  • Returns void

Constructors

  • Type Parameters

    Parameters

    • room: RoomType
    • stream: BaseGameDataMessage[]

      The game data stream that the room will broadcast.

    • delta: number

      The time that has passed since the last fixed update call, in seconds.

    Returns RoomFixedUpdateEvent<RoomType>

Generated using TypeDoc