Skip to main content
Version: 2.x

Connect Room

Connects the room to an ODIN gateway and joins it with the given authentication token. The call returns right away: On Room Joined fires once the room is joined, and On Peer Joined fires for every peer that is already in the room or joins later. Bind the room events before calling this node.

  • Node type: Callable function. Has execution pins and runs when it is reached in the event graph.
  • Target: Odin Room
  • Menu category: Odin
  • Search keywords: Start Connection, Start Room, Join, JoinRoom, Join Room
  • C++: UOdinRoom::ConnectRoom

Inputs​

NameTypeDescription
TargetOdin RoomThe Odin Room to call this function on.
GatewayStringThe Gateway URL (e.g. 'https://gateway.odin.4players.io').
AuthenticationStringThe authentication token (JWT) or signed JSON payload. Generate this using Generate Room Token.
CryptoOdin CryptoOptional crypto extension for end-to-end encryption, created with Construct Crypto Extension. Leave it empty for an unencrypted room.

Outputs​

NameTypeDescription
SuccessBooleanTrue if the connection was started. Failures are logged.
Return ValueOdin RoomThe room itself.