Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
FInputDeviceId Struct Reference

#include <CoreMiscDefines.h>

Public Member Functions

FORCEINLINE FInputDeviceId ()
 
 FInputDeviceId (const FInputDeviceId &)=default
 
FORCEINLINE int32 GetId () const
 
FORCEINLINE bool IsValid () const
 
FORCEINLINE bool operator== (const FInputDeviceId &Other) const
 
FORCEINLINE bool operator!= (const FInputDeviceId &Other) const
 
FORCEINLINE bool operator< (const FInputDeviceId &Other) const
 
FORCEINLINE bool operator<= (const FInputDeviceId &Other) const
 
FORCEINLINE bool operator> (const FInputDeviceId &Other) const
 
FORCEINLINE bool operator>= (const FInputDeviceId &Other) const
 

Static Public Member Functions

static FORCEINLINE FInputDeviceId CreateFromInternalId (int32 InInternalId)
 

Private Attributes

int32 InternalId
 

Friends

FORCEINLINE friend uint32 GetTypeHash (const FInputDeviceId &InputId)
 

Detailed Description

Represents a single input device such as a gamepad, keyboard, or mouse.

Has a globally unique identifier that is assigned by the IPlatformInputDeviceMapper

Definition at line 385 of file CoreMiscDefines.h.

Constructor & Destructor Documentation

◆ FInputDeviceId() [1/2]

FORCEINLINE FInputDeviceId::FInputDeviceId ( )
inlineexplicit

Definition at line 387 of file CoreMiscDefines.h.

◆ FInputDeviceId() [2/2]

FInputDeviceId::FInputDeviceId ( const FInputDeviceId & )
default

Member Function Documentation

◆ CreateFromInternalId()

static FORCEINLINE FInputDeviceId FInputDeviceId::CreateFromInternalId ( int32 InInternalId)
inlinestatic

Explicit function to create from an internal id

Definition at line 394 of file CoreMiscDefines.h.

◆ GetId()

FORCEINLINE int32 FInputDeviceId::GetId ( ) const
inline

Definition at line 401 of file CoreMiscDefines.h.

◆ IsValid()

FORCEINLINE bool FInputDeviceId::IsValid ( ) const
inline

Sees if this is a valid input device

Definition at line 407 of file CoreMiscDefines.h.

◆ operator!=()

FORCEINLINE bool FInputDeviceId::operator!= ( const FInputDeviceId & Other) const
inline

Definition at line 417 of file CoreMiscDefines.h.

◆ operator<()

FORCEINLINE bool FInputDeviceId::operator< ( const FInputDeviceId & Other) const
inline

Definition at line 422 of file CoreMiscDefines.h.

◆ operator<=()

FORCEINLINE bool FInputDeviceId::operator<= ( const FInputDeviceId & Other) const
inline

Definition at line 427 of file CoreMiscDefines.h.

◆ operator==()

FORCEINLINE bool FInputDeviceId::operator== ( const FInputDeviceId & Other) const
inline

Definition at line 412 of file CoreMiscDefines.h.

◆ operator>()

FORCEINLINE bool FInputDeviceId::operator> ( const FInputDeviceId & Other) const
inline

Definition at line 432 of file CoreMiscDefines.h.

◆ operator>=()

FORCEINLINE bool FInputDeviceId::operator>= ( const FInputDeviceId & Other) const
inline

Definition at line 437 of file CoreMiscDefines.h.

Friends And Related Symbol Documentation

◆ GetTypeHash

FORCEINLINE friend uint32 GetTypeHash ( const FInputDeviceId & InputId)
friend

Definition at line 442 of file CoreMiscDefines.h.

Member Data Documentation

◆ InternalId

int32 FInputDeviceId::InternalId
private

Raw id, will be allocated by application layer

See also
IPlatformInputDeviceMapper::AllocateNewInputDeviceId

Definition at line 454 of file CoreMiscDefines.h.

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