UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Net::FNetToken Class Reference

#include <NetToken.h>

Public Types

enum  : uint32 { Invalid = 0U }
 
enum  : uint32 { InvalidTokenTypeId = ~FTypeId(0) }
 
enum  : uint32 { InvalidTokenIndex = 0U }
 
enum  : uint32 { TokenTypeIdBits = 3U }
 
enum  : uint32 { TokenBits = 20U }
 
enum  : uint32 { MaxTypeIdCount = 1U << TokenTypeIdBits }
 
enum  : uint32 { MaxNetTokenCount = 1U << TokenBits }
 
enum class  ENetTokenAuthority { None , Authority }
 
typedef uint32 FTypeId
 

Public Member Functions

 FNetToken ()
 
bool IsValid () const
 
bool IsAssignedByAuthority () const
 
uint32 GetIndex () const
 
FTypeId GetTypeId () const
 
bool operator== (const FNetToken &Other) const
 
FString ToString () const
 

Friends

class UE::Net::FNetTokenStore
 
uint32 GetTypeHash (const FNetToken &Token)
 

Member Typedef Documentation

◆ FTypeId

Member Enumeration Documentation

◆ anonymous enum

Enumerator
Invalid 

◆ anonymous enum

Enumerator
InvalidTokenTypeId 

◆ anonymous enum

Enumerator
InvalidTokenIndex 

◆ anonymous enum

How many bits we use to express the TypeId for NetTokens, Increasing this value will break network compatibility and might need versioning for replays.

Enumerator
TokenTypeIdBits 

◆ anonymous enum

How many bits we use to express the index part of NetTokens

Enumerator
TokenBits 

◆ anonymous enum

Enumerator
MaxTypeIdCount 

◆ anonymous enum

Enumerator
MaxNetTokenCount 

◆ ENetTokenAuthority

Enumerator
None 
Authority 

Constructor & Destructor Documentation

◆ FNetToken()

UE::Net::FNetToken::FNetToken ( )
inline

Member Function Documentation

◆ GetIndex()

uint32 UE::Net::FNetToken::GetIndex ( ) const
inline

◆ GetTypeId()

FTypeId UE::Net::FNetToken::GetTypeId ( ) const
inline

◆ IsAssignedByAuthority()

bool UE::Net::FNetToken::IsAssignedByAuthority ( ) const
inline

◆ IsValid()

bool UE::Net::FNetToken::IsValid ( ) const
inline

◆ operator==()

bool UE::Net::FNetToken::operator== ( const FNetToken Other) const
inline

◆ ToString()

FString UE::Net::FNetToken::ToString ( ) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FNetToken Token)
friend

◆ UE::Net::FNetTokenStore

Member Data Documentation

◆ bIsAssignedByAuthority

uint32 UE::Net::FNetToken::bIsAssignedByAuthority

◆ Index

uint32 UE::Net::FNetToken::Index

◆ Padding

uint32 UE::Net::FNetToken::Padding

◆ TypeId

uint32 UE::Net::FNetToken::TypeId

◆ Value

uint32 UE::Net::FNetToken::Value

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