EBus interface used to send light bar requests to connected input devices.
More...
#include <InputLightBarRequestBus.h>
Inherits AZ::EBusTraits.
|
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.
|
|
EBus interface used to send light bar requests to connected input devices.
◆ 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] | color | The color to set the light bar |
◆ 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:
- Code/Framework/AzFramework/AzFramework/Input/Buses/Requests/InputLightBarRequestBus.h