Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Multiplayer::SessionConfig Struct Reference

#include <SessionConfig.h>

Public Member Functions

 AZ_RTTI (SessionConfig, "{992DD4BE-8BA5-4071-8818-B99FD2952086}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

uint64_t m_creationTime = 0
 A time stamp indicating when this session was created. Format is a number expressed in Unix time as milliseconds.
 
uint64_t m_terminationTime = 0
 A time stamp indicating when this data object was terminated. Same format as creation time.
 
AZStd::string m_creatorId
 A unique identifier for a player or entity creating the session.
 
AZStd::unordered_map< AZStd::string, AZStd::string > m_sessionProperties
 A collection of custom properties for a session.
 
AZStd::string m_matchmakingData
 The matchmaking process information that was used to create the session.
 
AZStd::string m_sessionId
 A unique identifier for the session.
 
AZStd::string m_sessionName
 A descriptive label that is associated with a session.
 
AZStd::string m_dnsName
 The DNS identifier assigned to the instance that is running the session.
 
AZStd::string m_ipAddress
 The IP address of the session.
 
uint16_t m_port = 0
 The port number for the session.
 
uint64_t m_maxPlayer = 0
 The maximum number of players that can be connected simultaneously to the session.
 
uint64_t m_currentPlayer = 0
 Number of players currently in the session.
 
AZStd::string m_status
 Current status of the session.
 
AZStd::string m_statusReason
 Provides additional information about session status.
 

Detailed Description

SessionConfig Properties describing a session.


The documentation for this struct was generated from the following file: