Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FPlatformUserId

Light Theme

Dark Theme

FPlatformUserId

Handle that defines a local user on this platform.

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/CoreMiscDefines.h
Include	#include "Misc/CoreMiscDefines.h"

Syntax

struct FPlatformUserId

Remarks

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.

Constructors

	Name	Description
	FPlatformUserId()	Create a default invalid Id
	FPlatformUserId ( const FPlatformUserId& )
	FPlatformUserId ( int32 InIndex )	Implicit conversion from user index is deprecated, use FPlatformMisc::GetPlatformUserForUserIndex

Functions

	Name	Description
FPlatformUse...	CreateFromInternalId ( int32 InInternalId )	Explicit function to create from an internal id
int32	GetInternalId()	Returns the internal id for debugging/etc
bool	IsValid()	Sees if this is a valid user

Operators

		Name	Description
	bool	operator!= ( const FPlatformUserId& Other )
	FPlatformUse...	operator= ( const FPlatformUserId& )
	bool	operator== ( const FPlatformUserId& Other )

Deprecated Functions

		Name	Description
	constexpr	FPlatformUserId ( int32 InIndex )	Implicit conversion from user index is deprecated, use FPlatformMisc::GetPlatformUserForUserIndex
	*	UE_DEPRECATED ( 5. x, "Implicit conversion to user index ..., useFPlatformMisc::GetUserIndexForPl... )	This should be deprecated when the online code uniformly handles FPlatformUserId