Navigation
API > API/Runtime > API/Runtime/ApplicationCore > API/Runtime/ApplicationCore/GenericPlatform
Inheritance Hierarchy
- IPlatformInputDeviceMapper
- FGenericPlatformInputDeviceMapper
References
| Module | ApplicationCore |
| Header | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformInputDeviceMapper.h |
| Include | #include "GenericPlatform/GenericPlatformInputDeviceMapper.h" |
Syntax
class FGenericPlatformInputDeviceMapper : public IPlatformInputDeviceMapper
Remarks
Generic implementation of the IPlatformInputDeviceMapper. This provides the base functionality that can be used on most platforms.
Variables
| Type | Name | Description | |
|---|---|---|---|
| const bool | bShouldBroadcastLegacyDelegates | ||
| bool | bUnpairInputDevicesWhenLoggingOut | Additional functionality that specializations can customize | |
| const bool | bUsingControllerIdAsUserId | Flags for backwards compatibility with the older "int32 ControllerId" implementation |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FGenericPlatformInputDeviceMapper
(
const bool InbUsingControllerIdAsUserId, |
Overridden from IPlatformInputDeviceMapper
| Type | Name | Description | |
|---|---|---|---|
| FInputDeviceId | Returns the next available input device id | ||
| FPlatformUserId | Allocates a new user id when a user becomes active, will return none if no more can be created | ||
| FInputDeviceId | Returns the default device id used for things like keyboard/mouse input | ||
| FPlatformUserId | GetPlatformUserForUserIndex
(
int32 LocalUserIndex |
Remap the legacy platform LocalUserIndex (often the same as ControllerId) to a FPlatformUserId. | |
| FPlatformUserId | Returns the 'Primary' Platform user for this platform. | ||
| FPlatformUserId | This is unsupported by default and will return PLATFORMUSERID_NONE on the generic platform | ||
| int32 | GetUserIndexForPlatformUser
(
FPlatformUserId UserId |
Remap a FPlatformUserId to the legacy platform LocalUserIndex (often the same as ControllerId). | |
| bool | 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 | ||
| void | OnUserLoginChangedEvent
(
bool bLoggedIn, |
Callback for when FCoreDelegates::OnUserLoginChangedEvent is broadcasted. | |
| bool | RemapControllerIdToPlatformUserAndDevice
(
int32 ControllerId, |
Remap the legacy "int32 ControllerId" to the updated FPlatformUserId and FInputDeviceId. | |
| bool | RemapUserAndDeviceToControllerId
(
FPlatformUserId UserId, |
Functions to provide compatibility between the old "int32 ControllerId" and the new FPlatformUserId and FInputDeviceId structs. | |
| bool | If true, than this device mapper will broadcast the older CoreDelegates as well as the new delegates. |