DoopelPonger
Public Member Functions | List of all members
InputCheckerContainer Class Reference

Holds a mapping of InputTriggerOptions to registered tags for deduplication checking. More...

Public Member Functions

 InputCheckerContainer ()
 
void AddInputCheckers (InputManager.InputTriggerOption triggerOption, string tag, List< InputChecker > newInputCheckers)
 Add to input checker to the data structure. More...
 
void RemoveInputCheckers (InputManager.InputTriggerOption triggerOption, string tag)
 Remove all InputCheckers that have a matching triggerOption and tag. More...
 
List< InputCheckerGetInputCheckers ()
 

Detailed Description

Holds a mapping of InputTriggerOptions to registered tags for deduplication checking.

If you're trying to add a trigger with the same tag, then just return and do nothing. If a new triggerOption and tag are added, it will overwrite the existing trigger(s). In other words: if triggerOption exists and tag in map is the same, do nothing if triggerOption exists and tag in map is different, write new tag to map

Constructor & Destructor Documentation

◆ InputCheckerContainer()

InputCheckerContainer.InputCheckerContainer ( )

Member Function Documentation

◆ AddInputCheckers()

void InputCheckerContainer.AddInputCheckers ( InputManager.InputTriggerOption  triggerOption,
string  tag,
List< InputChecker newInputCheckers 
)

Add to input checker to the data structure.

If you're trying to add a trigger with the same tag, then just return and do nothing. If a new triggerOption and tag are added, it will overwrite the existing trigger(s). In other words: if triggerOption exists and tag in map is the same, do nothing if triggerOption exists and tag in map is different, write new tag to map

Parameters
triggerOptionThe InputTriggerOption that should be checked every Update tick
tagUnique identifier to show what part of the code registered the triggerOption
newInputCheckersThe types of KeyCode checks to perform in the Update tick.

◆ GetInputCheckers()

List<InputChecker> InputCheckerContainer.GetInputCheckers ( )
Returns
All InputCheckers currently active.

◆ RemoveInputCheckers()

void InputCheckerContainer.RemoveInputCheckers ( InputManager.InputTriggerOption  triggerOption,
string  tag 
)

Remove all InputCheckers that have a matching triggerOption and tag.

Parameters
triggerOptionInputTriggerOption to remove.
tagMatching identifier to remove.

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