DoopelPonger
Public Member Functions | Public Attributes | List of all members
MovementInputChecker Class Reference

InputChecker to used to get a range of -1 to 1 based on user input. More...

Inheritance diagram for MovementInputChecker:
Inheritance graph
[legend]
Collaboration diagram for MovementInputChecker:
Collaboration graph
[legend]

Public Member Functions

 MovementInputChecker (InputManager.InputTriggerOption inputTriggerOption, InputActionMapper.Action positiveAction, InputActionMapper.Action negativeAction, InputManager.MovementTrigger trigger, string tag)
 
override InputCheckerAction GetCheckerAction ()
 Method called every Update tick to see if the inputTriggerOption should be actived. More...
 
override string GetIdentifierString ()
 
- Public Member Functions inherited from InputChecker
 InputChecker (InputManager.InputTriggerOption inputTriggerOption, string tag)
 

Public Attributes

readonly InputManager.MovementTrigger trigger
 
- Public Attributes inherited from InputChecker
readonly string tag
 
readonly InputManager.InputTriggerOption inputTriggerOption
 

Additional Inherited Members

- Protected Attributes inherited from InputChecker
InputActionMapper inputActionMapper
 

Detailed Description

InputChecker to used to get a range of -1 to 1 based on user input.

If no keys are pressed, 0 is sent to the listener. If the positive key is pressed 1 is sent and if the negative key is pressed -1 is sent. If both positive and negative are pressed then 0 is sent.

Constructor & Destructor Documentation

◆ MovementInputChecker()

MovementInputChecker.MovementInputChecker ( InputManager.InputTriggerOption  inputTriggerOption,
InputActionMapper.Action  positiveAction,
InputActionMapper.Action  negativeAction,
InputManager.MovementTrigger  trigger,
string  tag 
)

Member Function Documentation

◆ GetCheckerAction()

override InputCheckerAction MovementInputChecker.GetCheckerAction ( )
virtual

Method called every Update tick to see if the inputTriggerOption should be actived.

Returns
A function to call in the next FixedUpdate.

Implements InputChecker.

◆ GetIdentifierString()

override string MovementInputChecker.GetIdentifierString ( )
virtual
Returns
Unique identifier for the type of input the child object is checking.

Implements InputChecker.

Member Data Documentation

◆ trigger

readonly InputManager.MovementTrigger MovementInputChecker.trigger

The callback to be notified of the movement value.


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