RoomEvents

Stores a subset of the settings required to create a Room, relative to Room events dispatching.

Constructor

new RoomEvents()

Creates a new instance of the RoomEvents class.
The RoomSettings#events property must be set to this instance during Room creation.
See

Members

allowUserCountChange :boolean

Indicates whether the SFSEvent.USER_COUNT_CHANGE event should be dispatched whenever the User/Player/Spectator count changes in the Room.
Type:
  • boolean
Default Value
  • false

allowUserEnter :boolean

Indicates whether the SFSEvent.USER_ENTER_ROOM event should be dispatched whenever a User joins the Room.
Type:
  • boolean
Default Value
  • false

allowUserExit :boolean

Indicates whether the SFSEvent.USER_EXIT_ROOM event should be dispatched whenever a User leaves the Room.
Type:
  • boolean
Default Value
  • false

allowUserVariablesUpdate :boolean

Indicates whether the SFSEvent.USER_VARIABLES_UPDATE event should be dispatched whenever a User in the Room updates its User Variables.
Type:
  • boolean
Default Value
  • false