Navigation
API > API/Runtime > API/Runtime/ApplicationCore
Generic implementation of the IPlatformInputDeviceMapper. This provides the base functionality that can be used on most platforms.
| Name | FGenericPlatformInputDeviceMapper |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformInputDeviceMapper.h |
| Include Path | #include "GenericPlatform/GenericPlatformInputDeviceMapper.h" |
Syntax
class FGenericPlatformInputDeviceMapper : public IPlatformInputDeviceMapper
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGenericPlatformInputDeviceMapper
(
const bool InbUsingControllerIdAsUserId, |
GenericPlatform/GenericPlatformInputDeviceMapper.h |
Functions
Public
Overridden from IPlatformInputDeviceMapper
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputDeviceId AllocateNewInputDeviceId() |
Returns the next available input device id | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual FPlatformUserId AllocateNewUserId() |
Allocates a new user id when a user becomes active, will return none if no more can be created | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual FInputDeviceId GetDefaultInputDevice() |
Returns the default device id used for things like keyboard/mouse input | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual FPlatformUserId GetPlatformUserForUserIndex
(
int32 LocalUserIndex |
Remap the legacy platform LocalUserIndex (often the same as ControllerId) to a FPlatformUserId. | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual FPlatformUserId GetPrimaryPlatformUser () |
Returns the 'Primary' Platform user for this platform. | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual FPlatformUserId GetUserForUnpairedInputDevices() |
This is unsupported by default and will return PLATFORMUSERID_NONE on the generic platform | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual int32 GetUserIndexForPlatformUser
(
FPlatformUserId UserId |
Remap a FPlatformUserId to the legacy platform LocalUserIndex (often the same as ControllerId). | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual bool IsUsingControllerIdAsUserId() |
If true, this device mapper is operating in a backward compatible mode where there is a 1:1 mapping between controller id and user id | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual bool RemapControllerIdToPlatformUserAndDevice
(
int32 ControllerId, |
Remap the legacy "int32 ControllerId" to the updated FPlatformUserId and FInputDeviceId. | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual bool RemapUserAndDeviceToControllerId
(
FPlatformUserId UserId, |
Functions to provide compatibility between the old "int32 ControllerId" and the new FPlatformUserId and FInputDeviceId structs. | GenericPlatform/GenericPlatformInputDeviceMapper.h | |
virtual bool ShouldBroadcastLegacyDelegates () |
If true, than this device mapper will broadcast the older CoreDelegates as well as the new delegates. | GenericPlatform/GenericPlatformInputDeviceMapper.h |
Protected
Overridden from IPlatformInputDeviceMapper
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUserLoginChangedEvent
(
bool bLoggedIn, |
Callback for when FCoreDelegates::OnUserLoginChangedEvent is broadcasted. | GenericPlatform/GenericPlatformInputDeviceMapper.h |