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

EBus interface used to send light bar requests to connected input devices. More...

#include <InputLightBarRequestBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = InputDeviceId
 EBus Trait: requests can be addressed to a specific InputDeviceId.
 

Public Member Functions

virtual void SetLightBarColor (const AZ::Color &color)=0
 
virtual void ResetLightBarColor ()=0
 
virtual ~InputLightBarRequests ()=default
 Default destructor.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 EBus Trait: requests should be handled by only one input device connected to each id.
 

Detailed Description

EBus interface used to send light bar requests to connected input devices.

Member Function Documentation

◆ ResetLightBarColor()

virtual void AzFramework::InputLightBarRequests::ResetLightBarColor ( )
pure virtual

Reset to default light bar color of the input device. All calls to this method should be addressed to a specific input device otherwise all devices that support it will respond!

Called using either:

  • EBus<>::Broadcast (any input device can respond to the request)
  • EBus<>::Event(id) (the given device can respond to the request)

◆ SetLightBarColor()

virtual void AzFramework::InputLightBarRequests::SetLightBarColor ( const AZ::Color &  color)
pure virtual

Set the current light bar color of the input device. All calls to this method should be addressed to a specific input device otherwise all devices that support it will respond!

Called using either:

  • EBus<>::Broadcast (any input device can respond to the request)
  • EBus<>::Event(id) (the given device can respond to the request)
Parameters
[in]colorThe color to set the light bar

Member Data Documentation

◆ AddressPolicy

const AZ::EBusAddressPolicy AzFramework::InputLightBarRequests::AddressPolicy = AZ::EBusAddressPolicy::ById
static

EBus Trait: requests can be addressed to a specific InputDeviceId using EBus<>::Event, which should be handled by only one device that has connected to the bus using that id. Input requests can also be sent using EBus<>::Broadcast, in which case they'll be sent to all input devices that have connected to the input event bus regardless of their id.

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