Slasher.Input.BaseInputHandler Class Reference

Inheritance diagram for Slasher.Input.BaseInputHandler:

Collaboration diagram for Slasher.Input.BaseInputHandler:

Classes
class	BaseInputReceiver
	An internal class to be define common functionality between the valued InputReceiver<T> and the unvalued InputReceiver. More...
class	InputReceiver
	An internal class to be used as an intermediary whenever an InputHandler recieves input from an InputAction. More...
class	InputReceiver< T >
	An internal class to be used as an intermediary whenever an InputHandler recieves input from an InputAction. More...

Public Member Functions
	BaseInputHandler (string actionMapPath, string actionPath)

Protected Member Functions
virtual bool	TryAddListeners ()
	Tries to add listeners, if they haven't been added already.
virtual bool	TryRemoveListeners ()
	Tries to remove listeners, if they've been added.

Properties
List< BaseInputReceiver >	receivers [get]
InputAction	inputAction [get]

Private Attributes
string	actionMapPath
string	actionPath
InputAction	inputActionBuffer
bool	inputActionBuffered
bool	addedListeners

Constructor & Destructor Documentation

BaseInputHandler()

Slasher.Input.BaseInputHandler.BaseInputHandler	(	string	actionMapPath,
		string	actionPath )

Member Function Documentation

TryAddListeners()

virtual bool Slasher.Input.BaseInputHandler.TryAddListeners ( )

protectedvirtual

Tries to add listeners, if they haven't been added already.

Returns

If listeners were added. Listeners will not be added if they have already been added.

Reimplemented in Slasher.Input.Analogue2DInputHandler, Slasher.Input.Button2DInputHandler, and Slasher.Input.ButtonInputHandler.

TryRemoveListeners()

virtual bool Slasher.Input.BaseInputHandler.TryRemoveListeners ( )

protectedvirtual

Tries to remove listeners, if they've been added.

The buffered values of receivers are wiped when listeners are removed.

Returns

If listeners were removed. Listeners may not be removed if they haven't been added, or if any receivers still have any listeners for their Actions.

Reimplemented in Slasher.Input.Analogue2DInputHandler, Slasher.Input.Button2DInputHandler, and Slasher.Input.ButtonInputHandler.

Here is the call graph for this function:

Member Data Documentation

actionMapPath

string Slasher.Input.BaseInputHandler.actionMapPath

private

actionPath

string Slasher.Input.BaseInputHandler.actionPath

private

addedListeners

bool Slasher.Input.BaseInputHandler.addedListeners

private

inputActionBuffer

InputAction Slasher.Input.BaseInputHandler.inputActionBuffer

private

inputActionBuffered

bool Slasher.Input.BaseInputHandler.inputActionBuffered

private

Property Documentation

inputAction

InputAction Slasher.Input.BaseInputHandler.inputAction

getprotected

receivers

List<BaseInputReceiver> Slasher.Input.BaseInputHandler.receivers

getabstractprotected

---

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

• StyleSlasherUnityProject/Assets/Scripts/Input/BaseInputHandler.cs