Open 3D Engine LocalUser Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
LocalUser::LocalUserNotifications Class Reference

#include <LocalUserNotificationBus.h>

Inherits EBusTraits.

Public Member Functions

virtual void OnLocalUserSignedIn ([[maybe_unused]] AzFramework::LocalUserId localUserId)
 
virtual void OnLocalUserSignedOut ([[maybe_unused]] AzFramework::LocalUserId localUserId)
 
virtual void OnLocalUserIdAssignedToLocalPlayerSlot ([[maybe_unused]] AzFramework::LocalUserId localUserId, [[maybe_unused]] AZ::u32 newLocalPlayerSlot, [[maybe_unused]] AZ::u32 previousLocalPlayerSlot=LocalPlayerSlotNone)
 
virtual void OnLocalUserIdRemovedFromLocalPlayerSlot ([[maybe_unused]] AzFramework::LocalUserId localUserId, [[maybe_unused]] AZ::u32 localPlayerSlot)
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 EBus Trait: local user notifications are addressed to a single address.
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 EBus Trait: local user notifications can be handled by multiple listeners.
 

Detailed Description

EBus interface used to listen for notifications related to assignment of local user ids to local player slots in addition to notifications related to individual local user profiles.

Member Function Documentation

virtual void LocalUser::LocalUserNotifications::OnLocalUserIdAssignedToLocalPlayerSlot ( [[maybe_unused] ] AzFramework::LocalUserId  localUserId,
[[maybe_unused] ] AZ::u32  newLocalPlayerSlot,
[[maybe_unused] ] AZ::u32  previousLocalPlayerSlot = LocalPlayerSlotNone 
)
inlinevirtual

Override to be notified when a local user id is assigned to a local player slot

Parameters
[in]localUserIdThe local user id that was assigned to a local player slot.
[in]newLocalPlayerSlotThe local player slot that the local user id now occupies.
[in]previousLocalPlayerSlotThe local player slot that the local user id previously occupied, or LocalPlayerSlotNone.
virtual void LocalUser::LocalUserNotifications::OnLocalUserIdRemovedFromLocalPlayerSlot ( [[maybe_unused] ] AzFramework::LocalUserId  localUserId,
[[maybe_unused] ] AZ::u32  localPlayerSlot 
)
inlinevirtual

Override to be notified when a local user id is removed from a local player slot

Parameters
[in]localUserIdThe local user id that was removed from a local player slot.
[in]localPlayerSlotThe local player slot that the local user id was removed from.
virtual void LocalUser::LocalUserNotifications::OnLocalUserSignedIn ( [[maybe_unused] ] AzFramework::LocalUserId  localUserId)
inlinevirtual

Override to be notified when a local user signs into the system

Parameters
[in]localUserIdThe local user id that signed into the system
virtual void LocalUser::LocalUserNotifications::OnLocalUserSignedOut ( [[maybe_unused] ] AzFramework::LocalUserId  localUserId)
inlinevirtual

Override to be notified when a local user signs out of the system

Parameters
[in]localUserIdThe local user id that signed out of the system
The documentation for this class was generated from the following file: