Open 3D Engine GridMate API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Attributes | Static Public Attributes | List of all members
GridMate::SessionParams Struct Reference

Inherited by GridMate::LANSessionParams.

Public Types

enum  Flags { SF_HOST_MIGRATION = (1 << 0), SF_HOST_MIGRATION_NO_EMPTY_SESSIONS = (1 << 1) }
 

Public Attributes

SessionTopology m_topology
 
unsigned int m_peerToPeerTimeout
 Peer to peer connectivity timeout in milliseconds. Recommended 2x the handshake time.
 
unsigned int m_hostMigrationTimeout
 Timeout for a host migration procedure in milliseconds. If it takes more time we will leave the session.
 
unsigned int m_hostMigrationVotingTime
 Minimum time that will spend voting (unless everybody voted - we have all the results) before we check the winner. IMPORTANT: value is clamped to less than 1/2 of m_hostMigrationTimeout.
 
unsigned int m_numPublicSlots
 Number of slots for players this session will have.
 
unsigned int m_numPrivateSlots
 
unsigned char m_flags
 
unsigned int m_numParams
 
GridSessionParam m_params [k_maxNumParams]
 An array of session params.
 

Static Public Attributes

static const unsigned int k_maxNumParams = 32
 

Member Enumeration Documentation

◆ Flags

Enumerator
SF_HOST_MIGRATION 

Enable/disable host migration for this session. (default: Enabled). It will always migrate the session even if you loose all connections.

SF_HOST_MIGRATION_NO_EMPTY_SESSIONS 

Same as SF_HOST_MIGRATION except it will NOT create sessions with 1 member, it will just leave the session.


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