UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPlatformUserId Struct Reference

#include <CoreMiscDefines.h>

Public Member Functions

UE_FORCEINLINE_HINT bool IsValid () const
 
UE_FORCEINLINE_HINT int32 GetInternalId () const
 
UE_FORCEINLINE_HINT bool operator== (const FPlatformUserId &Other) const
 
UE_FORCEINLINE_HINT bool operator!= (const FPlatformUserId &Other) const
 
UE_FORCEINLINE_HINT constexpr operator int32 () const
 

Static Public Member Functions

static FPlatformUserId CreateFromInternalId (int32 InInternalId)
 

Friends

UE_FORCEINLINE_HINT 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.

Member Function Documentation

◆ CreateFromInternalId()

static FPlatformUserId FPlatformUserId::CreateFromInternalId ( int32  InInternalId)
inlinestatic

Explicit function to create from an internal id

◆ GetInternalId()

UE_FORCEINLINE_HINT int32 FPlatformUserId::GetInternalId ( ) const
inline

Returns the internal id for debugging/etc

◆ IsValid()

UE_FORCEINLINE_HINT bool FPlatformUserId::IsValid ( ) const
inline

Sees if this is a valid user

◆ operator int32()

UE_FORCEINLINE_HINT constexpr FPlatformUserId::operator int32 ( ) const
inlineconstexpr

◆ operator!=()

UE_FORCEINLINE_HINT bool FPlatformUserId::operator!= ( const FPlatformUserId Other) const
inline

◆ operator==()

UE_FORCEINLINE_HINT bool FPlatformUserId::operator== ( const FPlatformUserId Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

UE_FORCEINLINE_HINT friend uint32 GetTypeHash ( const FPlatformUserId UserId)
friend

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