#include <InputChannelEventListener.h>
Inherits InputChannelNotificationBus::Handler.
Inherited by AzFramework::InputContext.
|
|
static AZ::s32 | GetPriorityFirst () |
|
static AZ::s32 | GetPriorityDebug () |
|
static AZ::s32 | GetPriorityDebugUI () |
|
static AZ::s32 | GetPriorityUI () |
|
static AZ::s32 | GetPriorityDefault () |
|
static AZ::s32 | GetPriorityLast () |
|
Class that handles input notifications by priority, and that allows events to be filtered by their channel name, device name, device index (local player) or any combination of the three.
◆ InputChannelEventListener() [1/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
bool |
autoConnect | ) |
|
|
explicit |
Constructor
- Parameters
-
[in] | autoConnect | Whether to connect to the input notification bus on construction |
◆ InputChannelEventListener() [2/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
AZ::s32 |
priority | ) |
|
|
explicit |
Constructor
- Parameters
-
[in] | priority | The priority used to sort relative to other input event listeners |
◆ InputChannelEventListener() [3/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
AZ::s32 |
priority, |
|
|
bool |
autoConnect |
|
) |
| |
|
explicit |
Constructor
- Parameters
-
[in] | priority | The priority used to sort relative to other input event listeners |
[in] | autoConnect | Whether to connect to the input notification bus on construction |
◆ InputChannelEventListener() [4/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
AZStd::shared_ptr< InputChannelEventFilter > |
filter | ) |
|
|
explicit |
Constructor
- Parameters
-
[in] | filter | The filter used to determine whether an inut event should be handled |
◆ InputChannelEventListener() [5/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
AZStd::shared_ptr< InputChannelEventFilter > |
filter, |
|
|
AZ::s32 |
priority |
|
) |
| |
|
explicit |
Constructor
- Parameters
-
[in] | filter | The filter used to determine whether an inut event should be handled |
[in] | priority | The priority used to sort relative to other input event listeners |
◆ InputChannelEventListener() [6/6]
AzFramework::InputChannelEventListener::InputChannelEventListener |
( |
AZStd::shared_ptr< InputChannelEventFilter > |
filter, |
|
|
AZ::s32 |
priority, |
|
|
bool |
autoConnect |
|
) |
| |
|
explicit |
Constructor
- Parameters
-
[in] | filter | The filter used to determine whether an inut event should be handled |
[in] | priority | The priority used to sort relative to other input event listeners |
[in] | autoConnect | Whether to connect to the input notification bus on construction |
◆ GetPriorityFirst()
static AZ::s32 AzFramework::InputChannelEventListener::GetPriorityFirst |
( |
| ) |
|
|
inlinestatic |
Predefined input event listener priority, used to sort handlers from highest to lowest
◆ OnInputChannelEventFiltered()
virtual bool AzFramework::InputChannelEventListener::OnInputChannelEventFiltered |
( |
const InputChannel & |
inputChannel | ) |
|
|
protectedpure virtual |
Override to be notified when an input channel is active or its state or value is updated, unless the event was consumed by a higher priority listener, or did not pass the filter.
- Parameters
-
[in] | inputChannel | The input channel that is active or whose state or value updated |
- Returns
- True if the input event has been consumed, false otherwise
Implemented in AzFramework::InputContext.
◆ SetFilter()
Allow the filter to be set as necessary even if already connected to the input event bus
- Parameters
-
[in] | filter | The filter used to determine whether an inut event should be handled |
The documentation for this class was generated from the following file:
- Code/Framework/AzFramework/AzFramework/Input/Events/InputChannelEventListener.h