UnrealVoxta 0.1.1
 
Loading...
Searching...
No Matches
FVoxtaVersionData Struct Reference

FVoxtaVersionData Data struct for managing version compatibility between the UnrealVoxta client and VoxtaServer. More...

#include <VoxtaVersionData.h>

Public Member Functions

FStringView GetCompatibleServerVersion () const
 Get the compatible server version that this client expects.
 
FStringView GetCompatibleAPIVersion () const
 Get the compatible API version that this client expects.
 
FStringView GetServerVersion () const
 Get the actual server version reported by the connected server.
 
FStringView GetApiVersion () const
 Get the actual API version reported by the connected server.
 
bool IsMatchingServerVersion () const
 Check if the connected server's version matches the expected version.
 
bool IsMatchingAPIVersion () const
 Check if the connected server's API version matches the expected version.
 
 FVoxtaVersionData (FString voxtaServerVersion, FString voxtaAPIVersion)
 
 FVoxtaVersionData ()=default
 Default constructor.
 

Detailed Description

FVoxtaVersionData Data struct for managing version compatibility between the UnrealVoxta client and VoxtaServer.

Contains both the targeted (compatible) versions and current server versions. Used during connection to verify API compatibility and track server version.

Constructor & Destructor Documentation

◆ FVoxtaVersionData() [1/2]

FVoxtaVersionData::FVoxtaVersionData ( FString voxtaServerVersion,
FString voxtaAPIVersion )
inlineexplicit

◆ FVoxtaVersionData() [2/2]

FVoxtaVersionData::FVoxtaVersionData ( )
default

Default constructor.

Member Function Documentation

◆ GetApiVersion()

FStringView FVoxtaVersionData::GetApiVersion ( ) const
inline

Get the actual API version reported by the connected server.

Used to check API compatibility.

Returns
The actual API version string.

◆ GetCompatibleAPIVersion()

FStringView FVoxtaVersionData::GetCompatibleAPIVersion ( ) const
inline

Get the compatible API version that this client expects.

Used for API compatibility checking during connection.

Returns
The expected compatible API version string.

◆ GetCompatibleServerVersion()

FStringView FVoxtaVersionData::GetCompatibleServerVersion ( ) const
inline

Get the compatible server version that this client expects.

Used for version compatibility checking during connection.

Returns
The expected compatible server version string.

◆ GetServerVersion()

FStringView FVoxtaVersionData::GetServerVersion ( ) const
inline

Get the actual server version reported by the connected server.

Used to check version compatibility.

Returns
The actual server version string.

◆ IsMatchingAPIVersion()

bool FVoxtaVersionData::IsMatchingAPIVersion ( ) const
inline

Check if the connected server's API version matches the expected version.

Used to validate API compatibility.

Returns
True if API version matches expected version.

◆ IsMatchingServerVersion()

bool FVoxtaVersionData::IsMatchingServerVersion ( ) const
inline

Check if the connected server's version matches the expected version.

Used to validate server compatibility.

Returns
True if server version matches expected version.

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