Info

  • License MIT License
  • Copyright Photon Engine. All rights reserved.

Statistics

  • Download count1,167 total downloads
  • Latest download count 1,167 downloads of latest version
  • Average download count1 downloads per day average

Owners

A list of all Actions, Conditions and Expressions supported in this addon.

Connection

  • Actions

    Set optional user id to {0}

    Set optional user id (required by some cloud services).

    Enable custom authentication of type {1} and set it's parameters to {0}

    Enable custom authentication and set it's parameters.

    Set hosting type to {0}

    Set hosting type.

    Set Self Hosted address to {0}

    Set Self Hosted address.

    Set Master server region to {0}

    Set Master server region.

    Set app id to {0}

    Set app id.

    Set app version to {0}

    Set app version.

    Connect to the name server

    Connect to the name server.

    Disconnect from all servers

    Disconnect from all servers.

    Disconnect client from Game server keeping player in room

    Disconnect client from Game server keeping player in room (to rejoin later) and connect to Master server if not connected.

    Leave room

    Leave room and connect to Master server if not connected.

  • Conditions

    Is connected to Nameserver

    True if client connected to Nameserver.

    Is connected to Master server

    True if client connected to Master server.

    Is connected to a lobby

    True if client connected to a lobby.

    Is joined to a room

    True if client joined to a room.

  • Expressions

    State

    Current client state.

    StateString

    Current client state string.

    UserId

    Previously set user id.

Lobby

  • Actions

    Create room {0} in lobby {1}/{2}

    Crate room.

    Join room {0} in lobby {3}/{4} (create if not exists: {2}, rejoin: {1})

    Join room.

    Join random room by {1} matching my room: {0} in lobby {2}/{3} with filter {4}

    Join random room.

    Request status of friends {0} (FindFriends)

    Request Master server for friends online status and joined rooms (FindFriends).

    Request lobbies statistics

    Request Master server for lobbies statistics.

  • Conditions

    On room list

    Triggered on room list receive.

    On room list update

    Triggered on room list update.

    On FindFriends result

    Triggered when FindFriends request completed.

    On lobbies statistics update

    Triggered when lobbies statistics update received.

    On application statistics update

    Triggered when application statistics update received.

    On join lobby

    Triggered on client joins lobby.

    On joinRandomRoom no match found

    Triggered when joinRandomRoom called and no match found.

  • Expressions

    MyRoomName

    Currently my room name.

    RoomCount

    Count of rooms available.

    RoomNameAt

    Name of room at index.

    RoomMaxPlayers

    Max players before room is considered full

    RoomIsOpen

    Defines if this room can be joined.

    RoomPlayerCount

    Count of player currently in room.

    RoomProperty

    Room property.

    FriendOnline

    True if friend is online.

    FriendRoom

    Currently joined room name or empyt string.

    LobbyStatsCount

    Count of lobbies statistics entries.

    LobbyStatsNameAt

    Lobby name.

    LobbyStatsTypeAt

    Lobby type.

    LobbyStatsPeerCountAt

    Number of players in the lobby (on Master, not playing).

    LobbyStatsGameCountAt

    Number of games in the lobby.

    AppStatsPeerCount

    Count of players currently online on Game servers.

    AppStatsMasterPeerCount

    Count of players on Master server (looking for game).

    AppStatsGameCount

    Count of games currently in use (includes invisible and full rooms, so it doesn't match lobby list).

Room

  • Actions

    Raise game event {0} with {1} payload to {4}, target {5}, group {2} ({3}, forward: {6})

    Raise game event.

    {0} interest group {1}

    Change client's interest group.

    Set custom property {0} of my room to {1} (forward: {2}, check {4}: {3})

    Set custom property of my room.

    Set properties listed in lobby to {0}

    Set properties listed in lobby.

    Set rooms visibility to {0}

    Set rooms visibility in the lobby's room list.

    Set room open status to {0}

    Set if this room can be joined.

    Set room max players to {0}

    Set max players before room is considered full.

    Set room live time to {0}

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

    Set suspended player live time to {0}

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

    Set user id check to to {0}

    Activates user id checks on joining if set to true.

  • Conditions

    On event {0}

    Triggered on custom event with specific code.

    On any event

    Triggered on any custom event.

    On actor properties change

    Triggered when actor properties changed.

    On my room properties change

    Triggered when my room properties changed.

    On join room

    Triggered when client joins room.

    On actor join

    Triggered when new actor joins the room.

    On actor leave

    Triggered when actor leaves the room.

    On actor suspend

    Triggered when actor suspended in the room.

  • Expressions

    MyActorNr

    Local actor number.

    EventCode

    Last Photon event code.

    EventData

    Last Photon event data.

    ActorNr

    Actor number.

    PropertyOfMyRoom

    Property of my room.

    ActorCount

    Count of actors in room.

    ActorNrAt

    Actor number of actor at index.

    ActorNameByNr

    Name of actor by number.

    PropertyOfActorByNr

    Property of actor by number.

    ChangedPropertiesCount

    Changed properties count.

    ChangedPropertyNameAt

    Changed property name at index.

    MasterActorNr

    Actor number of room master.

    WebRpcUriPath

    Request path of WrbRpc which triggered OnWebRpc condition.

    WebRpcResultCode

    Result code returned by remote procedure.

    WebRpcData

    Data returned by remote procedure.

Lobby & Room

  • Actions

    Call remote procedure (WebRPC) {0} with {1} as {2}

    Call remote procedure (WebRPC).

  • Conditions

    On WebRpc result

    Triggered when WebRPC request completed.

Actor

  • Actions

    Set name of local actor to {0}

    Set name of local actor.

    Set actor {0} custom property {1} to {2} (forward: {3}, check {5}: {4})

    Set custom property of actor.

Common

  • Actions

    Reset

    Disconnects and creates new client instance.

Client

  • Conditions

    On error

    Triggered on error.

    On state change

    Triggered on client state change.

    On disconnect

    Triggered when client gets disconnected from all servers.

  • Expressions

    ErrorCode

    Last error code.

    ErrorMessage

    Last error message.