Class: Room

Photon.LoadBalancing. Room

Represents a room client joins or is joined to. Extend to implement custom logic. Custom properties can be set via setCustomProperty() while being in the room.

new Room(name)

Parameters:
Name Type Description
name string Room name.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2049

Mixes In

Methods

setCustomProperties(properties, webForward, expectedProperties)

Sets custom property

Parameters:
Name Type Argument Default Description
properties object Table of properties to set.
webForward boolean <optional>
false Forward to web hook.
expectedProperties object <optional>
Table of properties expected when update occurs. (CAS : "Check And Swap")
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2083

setCustomProperty(name, value, webForward, expectedValue)

Sets custom property

Parameters:
Name Type Argument Default Description
name string Name of the property.
value object Property value.
webForward boolean <optional>
false Forward to web hook.
expectedValue object <optional>
Property value expected when update occurs. (CAS : "Check And Swap")
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2060

setEmptyRoomLiveTime(emptyRoomLiveTime)

Sets room live time in the server room cache after all clients have left the room.

Parameters:
Name Type Description
emptyRoomLiveTime number New live time value in ms.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2142

setIsOpen(isOpen)

Sets if this room can be joined.

Parameters:
Name Type Description
isOpen boolean New property value.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2120

setIsVisible(isVisible)

Sets rooms visibility in the lobby's room list.

Parameters:
Name Type Description
isVisible boolean New visibility value.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2109

setMaxPlayers(maxPlayers)

Sets max players before room is considered full.

Parameters:
Name Type Description
maxPlayers number New max players value.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2131

setPlugins(plugins)

Sets expected server plugins.

Parameters:
Name Type Description
plugins string[] New plugins list.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2158

setPropsListedInLobby(props)

Sets list of the room properties to pass to the RoomInfo list in a lobby.

Parameters:
Name Type Description
props string[] Array of properties names.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2174

setSuspendedPlayerLiveTime(suspendedPlayerLiveTime)

Sets time in ms indicating how long suspended player will be kept in the room.

Parameters:
Name Type Description
suspendedPlayerLiveTime number New live time value in ms.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2150

setUniqueUserId(unique)

activates user id checks on joining if set to true.

Parameters:
Name Type Description
unique boolean New property value.
Source:
  • Photon-Javascript_v4-0-0-7_Cloud_SDK.js, line 2166