#include <LocalUserSystemComponent.h>

Inherits AZ::Component, and LocalUserRequestBus::Handler.

Classes
class	Implementation
	Base class for platform specific implementations of the local user system component. More...

Public Member Functions
	AZ_COMPONENT (LocalUserSystemComponent, "{D22DBCC8-9F44-47F6-86CA-0BE1F52D1727}")

	LocalUserSystemComponent ()
	Constructor.

	~LocalUserSystemComponent () override=default
	Default destructor.

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)
	AZ::ComponentDescriptor::Reflect

static void	GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
	AZ::ComponentDescriptor::GetProvidedServices

static void	GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
	AZ::ComponentDescriptor::GetIncompatibleServices

Protected Member Functions
void	Activate () override
	AZ::Component::Activate

void	Deactivate () override
	AZ::Component::Deactivate

AZStd::shared_ptr< LocalUserProfile >	FindLocalUserProfile (AzFramework::LocalUserId localUserId) override
	LocalUser::LocalUserRequests::FindLocalUserProfile

AZ::u32	GetMaxLocalUsers () const override
	LocalUser::LocalUserRequests::GetMaxLocalUsers

bool	IsLocalUserSignedIn (AzFramework::LocalUserId localUserId) override
	LocalUser::LocalUserRequests::IsLocalUserSignedIn

AZStd::string	GetLocalUserName (AzFramework::LocalUserId localUserId) override
	LocalUser::LocalUserRequests::GetLocalUserName

AZ::u32	AssignLocalUserIdToLocalPlayerSlot (AzFramework::LocalUserId localUserId, AZ::u32 localPlayerSlot=LocalPlayerSlotAny) override
	LocalUser::LocalUserRequests::AssignLocalUserIdToLocalPlayerSlot

AZ::u32	RemoveLocalUserIdFromLocalPlayerSlot (AzFramework::LocalUserId localUserId) override
	LocalUser::LocalUserRequests::RemoveLocalUserIdFromLocalPlayerSlot

AzFramework::LocalUserId	GetLocalUserIdAssignedToLocalPlayerSlot (AZ::u32 localPlayerSlot) override
	LocalUser::LocalUserRequests::GetLocalUserIdAssignedToLocalPlayerSlot

AZ::u32	GetLocalPlayerSlotOccupiedByLocalUserId (AzFramework::LocalUserId localUserId) override
	LocalUser::LocalUserRequests::GetLocalPlayerSlotOccupiedByLocalUserId

void	ClearAllLocalUserIdToLocalPlayerSlotAssignments () override
	LocalUser::LocalUserRequests::ClearAllLocalUserIdToLocalPlayerSlotAssignments

Detailed Description

A system component providing functionality for mapping local user ids to local player slots, and managing local user profiles. Please note that while some platforms have no concept of a local user profile, the functionality for assigning local user ids to local player slots can still be used because local user ids are represented instead by unique input device indices.

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

Gems/LocalUser/Code/Source/LocalUserSystemComponent.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description