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_SDK.js, line 1322

Mixes In

Methods

clearExpectedUsers()

Attempts to remove all current expected users from the server's Slot Reservation list. Note that this operation can conflict with new/other users joining. They might be adding users to the list of expected users before or after this client called ClearExpectedUsers. This room's expectedUsers value will update, when the server sends a successful update. Internals: This methods wraps up setting the ExpectedUsers property of a room.

Source:
  • Photon-Javascript_SDK.js, line 1468

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_SDK.js, line 1356

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_SDK.js, line 1333

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_SDK.js, line 1421

setIsOpen(isOpen)

Sets if this room can be joined.

Parameters:
Name Type Description
isOpen boolean New property value.
Source:
  • Photon-Javascript_SDK.js, line 1399

setIsVisible(isVisible)

Sets rooms visibility in the lobby's room list.

Parameters:
Name Type Description
isVisible boolean New visibility value.
Source:
  • Photon-Javascript_SDK.js, line 1388

setMasterClient(actorNr)

Asks the server to assign another player as Master Client of your current room. This method calls an operation on the server to set a new Master Client, which takes a roundtrip. In case of success, this client and the others get the new Master Client from the server.

Parameters:
Name Type Description
actorNr number New Master Client actor ID.
Source:
  • Photon-Javascript_SDK.js, line 1481

setMaxPlayers(maxPlayers)

Sets max players before room is considered full.

Parameters:
Name Type Description
maxPlayers number New max players value.
Source:
  • Photon-Javascript_SDK.js, line 1410

setPlugins(plugins)

Sets expected server plugins.

Parameters:
Name Type Description
plugins string[] New plugins list.
Source:
  • Photon-Javascript_SDK.js, line 1443

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_SDK.js, line 1451

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_SDK.js, line 1459

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_SDK.js, line 1432