FPlatformUserId Struct Reference

#include <CoreMiscDefines.h>

Public Member Functions
FORCEINLINE	FPlatformUserId ()
	FPlatformUserId (const FPlatformUserId &)=default
FPlatformUserId &	operator= (const FPlatformUserId &)=default
FORCEINLINE bool	IsValid () const
FORCEINLINE int32	GetInternalId () const
FORCEINLINE bool	operator== (const FPlatformUserId &Other) const
FORCEINLINE bool	operator!= (const FPlatformUserId &Other) const
FORCEINLINE constexpr	FPlatformUserId (int32 InIndex)
FORCEINLINE constexpr	operator int32 () const

Static Public Member Functions
static FORCEINLINE FPlatformUserId	CreateFromInternalId (int32 InInternalId)

Private Attributes
int32	InternalId

Friends
FORCEINLINE friend uint32	GetTypeHash (const FPlatformUserId &UserId)

Detailed Description

Handle that defines a local user on this platform. This used to be just a typedef int32 that was used interchangeably as ControllerId and LocalUserIndex. Moving forward these will be allocated by the platform application layer.

Definition at line 321 of file CoreMiscDefines.h.

Constructor & Destructor Documentation

FPlatformUserId() [1/3]

FORCEINLINE FPlatformUserId::FPlatformUserId ( )

inline

Create a default invalid Id

Definition at line 324 of file CoreMiscDefines.h.

FPlatformUserId() [2/3]

FPlatformUserId::FPlatformUserId ( const FPlatformUserId & )

default

FPlatformUserId() [3/3]

FORCEINLINE constexpr FPlatformUserId::FPlatformUserId ( int32 InIndex )

inlineconstexpr

Definition at line 366 of file CoreMiscDefines.h.

Member Function Documentation

CreateFromInternalId()

static FORCEINLINE FPlatformUserId FPlatformUserId::CreateFromInternalId ( int32 InInternalId )

inlinestatic

Explicit function to create from an internal id

Definition at line 342 of file CoreMiscDefines.h.

GetInternalId()

FORCEINLINE int32 FPlatformUserId::GetInternalId ( ) const

inline

Returns the internal id for debugging/etc

Definition at line 336 of file CoreMiscDefines.h.

IsValid()

FORCEINLINE bool FPlatformUserId::IsValid ( ) const

inline

Sees if this is a valid user

Definition at line 330 of file CoreMiscDefines.h.

operator int32()

FORCEINLINE constexpr FPlatformUserId::operator int32 ( ) const

inlineconstexpr

Definition at line 370 of file CoreMiscDefines.h.

operator!=()

FORCEINLINE bool FPlatformUserId::operator!= ( const FPlatformUserId & Other ) const

inline

Definition at line 354 of file CoreMiscDefines.h.

operator=()

FPlatformUserId & FPlatformUserId::operator= ( const FPlatformUserId & )

default

operator==()

FORCEINLINE bool FPlatformUserId::operator== ( const FPlatformUserId & Other ) const

inline

Definition at line 349 of file CoreMiscDefines.h.

Friends And Related Symbol Documentation

GetTypeHash

FORCEINLINE friend uint32 GetTypeHash ( const FPlatformUserId & UserId )

friend

Definition at line 359 of file CoreMiscDefines.h.

Member Data Documentation

InternalId

int32 FPlatformUserId::InternalId

private

Raw id, will be allocated by application layer

Definition at line 374 of file CoreMiscDefines.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/CoreMiscDefines.h