Navigation
API > API/Runtime > API/Runtime/Core
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.
| Name | FPlatformUserId |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/CoreMiscDefines.h |
| Include Path | #include "Misc/CoreMiscDefines.h" |
Syntax
struct FPlatformUserId
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InternalId | int32 | Raw id, will be allocated by application layer | Misc/CoreMiscDefines.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetInternalId() |
Returns the internal id for debugging/etc | Misc/CoreMiscDefines.h | |
bool IsValid() |
Sees if this is a valid user | Misc/CoreMiscDefines.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FPlatformUserId CreateFromInternalId
(
int32 InInternalId |
Explicit function to create from an internal id | Misc/CoreMiscDefines.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
constexpr operator int32() |
This should be deprecated when the online code uniformly handles FPlatformUserId */ UE_DEPRECATED(5.x, "Implicit conversion to user index is deprecated, use FPlatformMisc::GetUserIndexForPlatformUser") | Misc/CoreMiscDefines.h | |
bool operator!=
(
const FPlatformUserId& Other |
Misc/CoreMiscDefines.h | ||
bool operator==
(
const FPlatformUserId& Other |
Misc/CoreMiscDefines.h |