A list of all Actions, Conditions and Expressions supported in this addon.
Signalling
-
Actions
Connect to signalling server at {0} clientTag {1}
Connect to the signalling server.
Log in with alias {0} clientTag {1}
Log in to the signalling server with a alias.
Simulate network conditions: latency {0} ms, jitter {1} ms, packet loss {2}% client tag {3}
Set artificial latency, jitter (PDV) and packet loss percentage for network simulation.
Disconnect from room Client Tag {0}
Disconnect from room
Disconnect from signalling server Client Tag {0}
Disconnect from signalling server
Leave room on signalling Client Tag {0}
Leave room on signalling server (room connection remain)
Request room list from signalling server Client Tag {0} game {1} instance {2} which {3}
Request the room list from the signalling server.
Request instance list from signalling server Client Tag {0} game {1}
Request the instance list from the signalling server.
-
Conditions
On signalling connected
Triggered when connected to the signalling.
On signalling logged in
Triggered when logged in to the signalling.
Is Connected (Client Tag {0})
True if connected to a signalling server
Is logged in (Client Tag {0})
True if logged in to a signalling server
On Left Room
On left room on signalling server
Is in room clientTag {0}
Returns true if the client tag is in a room.
On signalling error
Triggered if an error occurs with the signalling server. The ErrorMessage expression indicates the type of error that occurred.
On Room List
Triggered when the room list is received from the signalling server. The RoomList expression contains the list of rooms.
On Instance List
Triggered when a request instance list is completed.
For each client
Triggered for each client.
-
Expressions
ErrorMessage
In On signalling error, the error message if available.
CurrentGame
Returns the Game of the client tag.
CurrentInstance
Returns the Instance of the client tag.
CurrentRoom
Returns the Room name of the client tag.
ListRoomCount
After On Room List, the number of rooms in the received list.
ListRoomName
Returns the name of the room at the specified index in the received list.
ListRoomPeerCount
Returns the number of peers in the room at the specified index in the received list.
ListRoomMaxPeerCount
Returns the maximum number of peers allowed in the room at the specified index in the received list.
ListRoomState
Returns the state of the room at the specified index in the received list.
ListInstanceCount
After On game instance list triggers, the number of game instances in the received list.
ListInstanceName
Returns the name of the game instance at the specified index in the received list.
ListInstancePeerCount
Returns the number of peers in the game instance at the specified index in the received list.
CurrentClient
current client tag
Room
-
Actions
Join room {2} Game {0} Instance {1} max-peers {4} clientTag {3}
Join a room on the signalling server.
Join room {2} Game {0} Instance {1} max-peers {4} locking {5} clientTag {3}
Automatically join a room on the signalling server.
Send message {3} to peer {0} tag {1} clientTag {2} mode {4}
Send a message to a peer in the room.
-
Conditions
On joined room
Triggered when successfully joined a room.
On peer message with tag {0}
Triggered when a message is received.
On peer connected
Triggered on peer connected to host.
Is host clientTag {0}
Returns true if the client tag is host.
Disconnected From signalling
Triggered on disconnected from signalling server
On Peer Disconnected
Triggered when peer disconnect (either from host or a peer leaving the host).
On Kicked
Triggered when kicked from a room
On any peer message received
Triggered when any message is received from a peer, regardless of the tag.
-
Expressions
Message
Returns the message of the revelant trigger.
Tag
Returns the message tag of the revelant trigger.
PeerID
Returns the peer ID of the revelant trigger.
ClientTag
Returns the client tag of the revelant trigger.
MyID
Returns the ID of the client tag.
PeerAlias
Returns the peer alias of the revelant trigger
HostID
Returns the host ID of the client tag.
LeaveReason
Returns in 'On Peer Disconnected', the leave reason if known
PeerCount
Returns the number of peers connected in the current room.
FromAlias
Returns the alias of the peer that sent the message in the revelant trigger
FromID
Returns the ID of the peer that sent the message in the revelant trigger
MyAlias
Returns the alias of the client tag.
HostAlias
Returns the alias of the host client tag.
PeerIDFromAlias
Returns the peer ID corresponding to a given alias for the specified client.
PeerAliasFromID
Returns the alias associated with a given peer ID for the specified client.
PeerIDAt
Returns the peer ID at the given index in the peer list for the specified client.
PeerAliasAt
Returns the alias at the given index in the peer list for the specified client.
Room: Host
-
Actions
Broadcast tag {1} message {3} (from {0}, Client Tag {2}, mode {4})
Send a message to a peer in the room.
Kick peer {0} Client Tag {2}(reason: {1}
Leave room on signalling server (room connection remain)