Emergency 20 Dokumentation  4.2.0
em5::multiplayer::HostEntry Struct Reference

#include <MatchmakingTypes.h>

Inheritance diagram for em5::multiplayer::HostEntry:
qsf::Object

Public Member Functions

 HostEntry ()
 
 HostEntry (const HostEntry &x)
 
HostEntryoperator= (const HostEntry &x)
 
void splitIPv6Addresses ()
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Public Attributes

bool hasPassword
 "true" is the game session is password protected, "false" otherwise More...
 
std::string sessionName
 The name of the game session. More...
 
uint32 maximumPlayerCount
 Maximum number of players in this game session. More...
 
uint32 currentPlayerCount
 Current number of connected players in this game session. More...
 
qsf::GlobalAssetId globalMapAssetId
 Global asset ID of the map the game session will be played on. More...
 
GameMode gameMode
 Game mode that will be played in this game session. More...
 
uint32 duration
 Duration of the game session in minutes. More...
 
bool playerSeparation
 If set, players can't influence each other (referring to AI) More...
 
uint64 proxySessionId
 Holds the proxy session id when the host is connected to a multiplayer proxy and has created a session. More...
 
std::string proxyHostname
 The hostname of the multiplayer proxy to which the host is connected to. More...
 
uint16 proxyPort
 The port of the multiplayer proxy to which the host is connected to. More...
 
std::string hostname
 
uint16 port
 
std::string ipv6_address
 
std::vector< std::string > ipv6_adressList
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Constructor & Destructor Documentation

em5::multiplayer::HostEntry::HostEntry ( )
inline
em5::multiplayer::HostEntry::HostEntry ( const HostEntry x)
inline

Member Function Documentation

HostEntry& em5::multiplayer::HostEntry::operator= ( const HostEntry x)
inline
void em5::multiplayer::HostEntry::splitIPv6Addresses ( )
inline

Member Data Documentation

uint32 em5::multiplayer::HostEntry::currentPlayerCount

Current number of connected players in this game session.

uint32 em5::multiplayer::HostEntry::duration

Duration of the game session in minutes.

GameMode em5::multiplayer::HostEntry::gameMode

Game mode that will be played in this game session.

qsf::GlobalAssetId em5::multiplayer::HostEntry::globalMapAssetId

Global asset ID of the map the game session will be played on.

bool em5::multiplayer::HostEntry::hasPassword

"true" is the game session is password protected, "false" otherwise

std::string em5::multiplayer::HostEntry::hostname
std::string em5::multiplayer::HostEntry::ipv6_address
std::vector<std::string> em5::multiplayer::HostEntry::ipv6_adressList
uint32 em5::multiplayer::HostEntry::maximumPlayerCount

Maximum number of players in this game session.

bool em5::multiplayer::HostEntry::playerSeparation

If set, players can't influence each other (referring to AI)

uint16 em5::multiplayer::HostEntry::port
std::string em5::multiplayer::HostEntry::proxyHostname

The hostname of the multiplayer proxy to which the host is connected to.

uint16 em5::multiplayer::HostEntry::proxyPort

The port of the multiplayer proxy to which the host is connected to.

uint64 em5::multiplayer::HostEntry::proxySessionId

Holds the proxy session id when the host is connected to a multiplayer proxy and has created a session.

std::string em5::multiplayer::HostEntry::sessionName

The name of the game session.


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