Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Static Protected Attributes | List of all members
FNetworkVersion Struct Reference

#include <NetworkVersion.h>

Public Member Functions

 DECLARE_DELEGATE_RetVal (uint32, FGetLocalNetworkVersionOverride)
 
 DECLARE_DELEGATE_RetVal_TwoParams (bool, FIsNetworkCompatibleOverride, uint32, uint32)
 
 DECLARE_DELEGATE_RetVal (uint32, FGetReplayCompatibleChangeListOverride)
 

Static Public Member Functions

static uint32 GetNetworkCompatibleChangelist ()
 
static uint32 GetReplayCompatibleChangelist ()
 
static uint32 GetEngineNetworkProtocolVersion ()
 
static uint32 GetGameNetworkProtocolVersion ()
 
static uint32 GetEngineCompatibleNetworkProtocolVersion ()
 
static uint32 GetGameCompatibleNetworkProtocolVersion ()
 
static uint32 GetNetworkProtocolVersion (const FGuid &VersionGuid)
 
static uint32 GetCompatibleNetworkProtocolVersion (const FGuid &VersionGuid)
 
static const FCustomVersionContainer & GetNetworkCustomVersions ()
 
static void RegisterNetworkCustomVersion (const FGuid &VersionGuid, int32 Version, int32 CompatibleVersion, const FName &FriendlyName)
 
static uint32 GetLocalNetworkVersion (bool AllowOverrideDelegate=true)
 
static bool IsNetworkCompatible (const uint32 LocalNetworkVersion, const uint32 RemoteNetworkVersion)
 
static FNetworkReplayVersion GetReplayVersion ()
 
static void SetProjectVersion (const TCHAR *InVersion)
 
static void SetGameNetworkProtocolVersion (uint32 GameNetworkProtocolVersion)
 
static void SetGameCompatibleNetworkProtocolVersion (uint32 GameCompatibleNetworkProtocolVersion)
 
static bool AreNetworkRuntimeFeaturesCompatible (EEngineNetworkRuntimeFeatures LocalFeatures, EEngineNetworkRuntimeFeatures RemoteFeatures)
 
static void DescribeNetworkRuntimeFeaturesBitset (EEngineNetworkRuntimeFeatures FeaturesBitflag, FStringBuilderBase &OutVerboseDescription)
 
static const FString & GetProjectVersion ()
 
static void InvalidateNetworkChecksum ()
 

Static Public Attributes

static FGetLocalNetworkVersionOverride GetLocalNetworkVersionOverride
 
static FIsNetworkCompatibleOverride IsNetworkCompatibleOverride
 
static FGetReplayCompatibleChangeListOverride GetReplayCompatibleChangeListOverride
 

Static Protected Member Functions

static FString & GetProjectVersion_Internal ()
 

Static Protected Attributes

static bool bHasCachedNetworkChecksum
 
static uint32 CachedNetworkChecksum
 
static bool bHasCachedReplayChecksum
 
static uint32 CachedReplayChecksum
 
static uint32 EngineNetworkProtocolVersion
 
static uint32 GameNetworkProtocolVersion
 
static uint32 EngineCompatibleNetworkProtocolVersion
 
static uint32 GameCompatibleNetworkProtocolVersion
 

Detailed Description

Definition at line 51 of file NetworkVersion.h.

Member Function Documentation

◆ AreNetworkRuntimeFeaturesCompatible()

static bool FNetworkVersion::AreNetworkRuntimeFeaturesCompatible ( EEngineNetworkRuntimeFeatures LocalFeatures,
EEngineNetworkRuntimeFeatures RemoteFeatures )
static

Compares if the connection's runtime features are compatible with each other

◆ DECLARE_DELEGATE_RetVal() [1/2]

FNetworkVersion::DECLARE_DELEGATE_RetVal ( uint32 ,
FGetLocalNetworkVersionOverride  )

Called in GetLocalNetworkVersion if bound

◆ DECLARE_DELEGATE_RetVal() [2/2]

FNetworkVersion::DECLARE_DELEGATE_RetVal ( uint32 ,
FGetReplayCompatibleChangeListOverride  )

Called in GetReplayCompatibleChangelist if bound

◆ DECLARE_DELEGATE_RetVal_TwoParams()

FNetworkVersion::DECLARE_DELEGATE_RetVal_TwoParams ( bool ,
FIsNetworkCompatibleOverride ,
uint32 ,
uint32  )

Called in IsNetworkCompatible if bound

◆ DescribeNetworkRuntimeFeaturesBitset()

static void FNetworkVersion::DescribeNetworkRuntimeFeaturesBitset ( EEngineNetworkRuntimeFeatures FeaturesBitflag,
FStringBuilderBase & OutVerboseDescription )
static

Build and return a string describing the status of the the network runtime features bitflag

◆ GetCompatibleNetworkProtocolVersion()

static uint32 FNetworkVersion::GetCompatibleNetworkProtocolVersion ( const FGuid & VersionGuid)
static

◆ GetEngineCompatibleNetworkProtocolVersion()

static uint32 FNetworkVersion::GetEngineCompatibleNetworkProtocolVersion ( )
static

◆ GetEngineNetworkProtocolVersion()

static uint32 FNetworkVersion::GetEngineNetworkProtocolVersion ( )
static

◆ GetGameCompatibleNetworkProtocolVersion()

static uint32 FNetworkVersion::GetGameCompatibleNetworkProtocolVersion ( )
static

◆ GetGameNetworkProtocolVersion()

static uint32 FNetworkVersion::GetGameNetworkProtocolVersion ( )
static

◆ GetLocalNetworkVersion()

static uint32 FNetworkVersion::GetLocalNetworkVersion ( bool AllowOverrideDelegate = true)
static

Generates a version number, that by default, is based on a checksum of the engine version + project name + project version string Game/project code can completely override what this value returns through the GetLocalNetworkVersionOverride delegate If called with AllowOverrideDelegate=false, we will not call the game project override. (This allows projects to call base implementation in their project implementation)

◆ GetNetworkCompatibleChangelist()

static uint32 FNetworkVersion::GetNetworkCompatibleChangelist ( )
static

◆ GetNetworkCustomVersions()

static const FCustomVersionContainer & FNetworkVersion::GetNetworkCustomVersions ( )
static

◆ GetNetworkProtocolVersion()

static uint32 FNetworkVersion::GetNetworkProtocolVersion ( const FGuid & VersionGuid)
static

◆ GetProjectVersion()

static const FString & FNetworkVersion::GetProjectVersion ( )
inlinestatic

Returns the project version used by networking

Returns
FString

Definition at line 142 of file NetworkVersion.h.

+ Here is the call graph for this function:

◆ GetProjectVersion_Internal()

static FString & FNetworkVersion::GetProjectVersion_Internal ( )
staticprotected

Used to allow BP only projects to override network versions

+ Here is the caller graph for this function:

◆ GetReplayCompatibleChangelist()

static uint32 FNetworkVersion::GetReplayCompatibleChangelist ( )
static

◆ GetReplayVersion()

static FNetworkReplayVersion FNetworkVersion::GetReplayVersion ( )
static

Generates a special struct that contains information to send to replay server

◆ InvalidateNetworkChecksum()

static void FNetworkVersion::InvalidateNetworkChecksum ( )
inlinestatic

Invalidates any cached network checksum and forces it to be recalculated on next request

Definition at line 147 of file NetworkVersion.h.

◆ IsNetworkCompatible()

static bool FNetworkVersion::IsNetworkCompatible ( const uint32 LocalNetworkVersion,
const uint32 RemoteNetworkVersion )
static

Determine if a connection is compatible with this instance

Parameters
bRequireEngineVersionMatchshould the engine versions match exactly
LocalNetworkVersioncurrent version of the local machine
RemoteNetworkVersioncurrent version of the remote machine
Returns
true if the two instances can communicate, false otherwise

◆ RegisterNetworkCustomVersion()

static void FNetworkVersion::RegisterNetworkCustomVersion ( const FGuid & VersionGuid,
int32 Version,
int32 CompatibleVersion,
const FName & FriendlyName )
static

◆ SetGameCompatibleNetworkProtocolVersion()

static void FNetworkVersion::SetGameCompatibleNetworkProtocolVersion ( uint32 GameCompatibleNetworkProtocolVersion)
static

Sets the game compatible network protocol version used for networking and invalidate cached values

◆ SetGameNetworkProtocolVersion()

static void FNetworkVersion::SetGameNetworkProtocolVersion ( uint32 GameNetworkProtocolVersion)
static

Sets the game network protocol version used for networking and invalidate cached values

◆ SetProjectVersion()

static void FNetworkVersion::SetProjectVersion ( const TCHAR * InVersion)
static

Sets the project version used for networking. Needs to be a function to verify string and correctly invalidate cached values

Parameters
InVersion
Returns
void

Member Data Documentation

◆ bHasCachedNetworkChecksum

bool FNetworkVersion::bHasCachedNetworkChecksum
staticprotected

Definition at line 156 of file NetworkVersion.h.

◆ bHasCachedReplayChecksum

bool FNetworkVersion::bHasCachedReplayChecksum
staticprotected

Definition at line 159 of file NetworkVersion.h.

◆ CachedNetworkChecksum

uint32 FNetworkVersion::CachedNetworkChecksum
staticprotected

Definition at line 157 of file NetworkVersion.h.

◆ CachedReplayChecksum

uint32 FNetworkVersion::CachedReplayChecksum
staticprotected

Definition at line 160 of file NetworkVersion.h.

◆ EngineCompatibleNetworkProtocolVersion

uint32 FNetworkVersion::EngineCompatibleNetworkProtocolVersion
staticprotected

Definition at line 168 of file NetworkVersion.h.

◆ EngineNetworkProtocolVersion

uint32 FNetworkVersion::EngineNetworkProtocolVersion
staticprotected

Definition at line 163 of file NetworkVersion.h.

◆ GameCompatibleNetworkProtocolVersion

uint32 FNetworkVersion::GameCompatibleNetworkProtocolVersion
staticprotected

Definition at line 170 of file NetworkVersion.h.

◆ GameNetworkProtocolVersion

uint32 FNetworkVersion::GameNetworkProtocolVersion
staticprotected

Definition at line 165 of file NetworkVersion.h.

◆ GetLocalNetworkVersionOverride

FGetLocalNetworkVersionOverride FNetworkVersion::GetLocalNetworkVersionOverride
static

Definition at line 55 of file NetworkVersion.h.

◆ GetReplayCompatibleChangeListOverride

FGetReplayCompatibleChangeListOverride FNetworkVersion::GetReplayCompatibleChangeListOverride
static

Definition at line 63 of file NetworkVersion.h.

◆ IsNetworkCompatibleOverride

FIsNetworkCompatibleOverride FNetworkVersion::IsNetworkCompatibleOverride
static

Definition at line 59 of file NetworkVersion.h.

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