An input which defers inputs to Unity's input system. More...

Inheritance diagram for PlatformerPro.UnityInput:

Public Member Functions
override ButtonState	GetActionButtonState (int buttonIndex)
	GetActionButtonState More...

override void	ForceButtonState (int index, ButtonState state)
	Allow some external component to set button state (for current frame only). More...

override bool	SetKey (KeyType type, KeyCode keyCode)
	Sets the keyboayrd key that corresponds to a Platform PRO input key. More...

override bool	SetKey (KeyType type, KeyCode keyCode, int keyNumber)
	Sets the keyboayrd key that corresponds to a Platform PRO input key. More...

override KeyCode	GetKeyForType (KeyType type, int keyNumber)
	Gets the key code for the given type. More...

override string	GetAxisForType (KeyType type)
	Gets the name of the axis for the given key type. More...

override bool	SetAxis (KeyType type, string axis, bool reverseAxis)
	Sets the joystick axis that corresponds to a Platform PRO input axis. More...

override bool	SaveInputData ()
	Saves the input data. More...

override bool	LoadInputData (string dataName)
	Loads the input data. More...

override void	LoadInputData (StandardInputData data)
	Loads the provided input data. More...

Public Member Functions inherited from PlatformerPro.Input
virtual void	ConsumeJumpButton ()
	Consumes a jump button down event converting it in to a button held event. Does nothing if the button is in another state. More...

virtual void	ConsumeRunButton ()
	Consumes a run button down event converting it in to a button held event. Does nothing if the button is in another state. More...

virtual void	ConsumeActionButton (int index)
	Consumes an action button down event converting it in to a button held event. Does nothing if the button is in another state. More...

Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
string	jumpButtonName = "Jump"
	String name of the JUMP button defined in the Unity Input Manager More...

string	runButtonName = "Fire1"
	String name of the RUN button defined in the Unity Input Manager More...

string	pauseButtonName = "Pause"
	String name of the PAUSE button defined in the Unity Input Manager More...

string	horizontalAxisName = "Horizontal"
	String name of the Horizontal axis defined in the Unity Input Manager More...

string	verticalAxisName = "Vertical"
	String name of the Vertical axis defined in the Unity Input Manager More...

string[]	actionButtons
	The action buttons defined in the Unity Input Manager with the first value in the array being the default. More...

Public Attributes inherited from PlatformerPro.Input
int	playerId
	The player who is assigned to this input. More...

Protected Member Functions
virtual ButtonState	GetButtonState (string button)
	Returns the button state (DOWN, UP, HELD, or NONE), for the button defined in the Unity Input Manager More...

Properties
override float	HorizontalAxis `[get]`
	HorizontalAxis More...

override int	HorizontalAxisDigital `[get]`
	HorizontalAxisDigital More...

override ButtonState	HorizontalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value and wasn't 0; Return ButtonState.UP if the axis state went from != 0 to 0. More...

override float	VerticalAxis `[get]`
	VerticalAxis More...

override int	VerticalAxisDigital `[get]`
	VerticalAxisDigital More...

override ButtonState	VerticalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value and wasn't 0; Return ButtonState.UP if the axis state went from != 0 to 0. More...

override ButtonState	JumpButton `[get]`
	JumpButton More...

override ButtonState	RunButton `[get]`
	RunButton More...

override ButtonState	PauseButton `[get]`
	PauseButton More...

override ButtonState	ActionButton `[get]`
	ActionButton More...

override bool	AnyKey `[get]`
	Returns true if any button or action key is being pressed. More...

override float	AltHorizontalAxis `[get]`
	A float value clamped between -1 for completely left and 1 for compeletely right. 0.5f would mean "half right". The exact interpretation of the values is up to the movement behaviours. More...

override int	AltHorizontalAxisDigital `[get]`
	A "digital" version of the alternate horizontal axis in which the only valid values are -1 for LEFT, 0 for NONE, and 1 for RIGHT. More...

override ButtonState	AltHorizontalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

override float	AltVerticalAxis `[get]`
	A float value clamped between -1 for completely DOWN and 1 for completely UP. 0.5f would mean "half up". The exact interpretation of the values is up to the movement behaviours. More...

override int	AltVerticalAxisDigital `[get]`
	A "digital" version of the vertical axis in which the only valid values are -1 for DOWN, 0 for NONE, and 1 for UP. More...

override ButtonState	AltVerticalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

Properties inherited from PlatformerPro.Input
abstract float	HorizontalAxis `[get]`
	A float value clamped between -1 for completely left and 1 for compeletely right. 0.5f would mean "half right". The exact interpretation of the values is up to the movement behaviours. More...

abstract int	HorizontalAxisDigital `[get]`
	A "digital" version of the horizontal axis in which the only valid values are -1 for LEFT, 0 for NONE, and 1 for RIGHT. More...

abstract ButtonState	HorizontalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

abstract float	VerticalAxis `[get]`
	A float value clamped between -1 for completely DOWN and 1 for completely UP. 0.5f would mean "half up". The exact interpretation of the values is up to the movement behaviours. More...

abstract int	VerticalAxisDigital `[get]`
	A "digital" version of the alternate vertical axis in which the only valid values are -1 for DOWN, 0 for NONE, and 1 for UP. More...

abstract ButtonState	VerticalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

abstract float	AltHorizontalAxis `[get]`
	A float value clamped between -1 for completely left and 1 for compeletely right. 0.5f would mean "half right". The exact interpretation of the values is up to the movement behaviours. More...

abstract int	AltHorizontalAxisDigital `[get]`
	A "digital" version of the alternate horizontal axis in which the only valid values are -1 for LEFT, 0 for NONE, and 1 for RIGHT. More...

abstract ButtonState	AltHorizontalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

abstract float	AltVerticalAxis `[get]`
	A float value clamped between -1 for completely DOWN and 1 for completely UP. 0.5f would mean "half up". The exact interpretation of the values is up to the movement behaviours. More...

abstract int	AltVerticalAxisDigital `[get]`
	A "digital" version of the vertical axis in which the only valid values are -1 for DOWN, 0 for NONE, and 1 for UP. More...

abstract ButtonState	AltVerticalAxisState `[get]`
	Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0. More...

abstract ButtonState	JumpButton `[get]`
	State of the jump button. More...

abstract ButtonState	RunButton `[get]`
	State of the run button. More...

abstract ButtonState	PauseButton `[get]`
	State of the pause button. More...

abstract ButtonState	ActionButton `[get]`
	State of the default action button. This could be pickup, attack, etc. If you need more buttons use the additional action use Input.GetActionButtonState() More...

abstract bool	AnyKey `[get]`
	Returns true if any button or action key is being pressed. More...

Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header `[get]`
	Gets the header string used to describe the component. More...

virtual string	DocLink `[get]`
	Gets a link to documentation site. More...

virtual string	VideoLink `[get]`
	Gets a link to a youtube video. More...

virtual string	Deprecated `[get]`
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Detailed Description

An input which defers inputs to Unity's input system.

Member Function Documentation

◆ ForceButtonState()

override void PlatformerPro.UnityInput.ForceButtonState	(	int	index,
		ButtonState	state
	)

virtual

Allow some external component to set button state (for current frame only).

Parameters

index	Index.
state	State.

Implements PlatformerPro.Input.

◆ GetActionButtonState()

override ButtonState PlatformerPro.UnityInput.GetActionButtonState ( int buttonIndex )

virtual

GetActionButtonState

Parameters

buttonIndex

Returns

Implements PlatformerPro.Input.

◆ GetAxisForType()

override string PlatformerPro.UnityInput.GetAxisForType ( KeyType type )

virtual

Gets the name of the axis for the given key type.

Returns: The axis name.

Parameters

type Type.

Implements PlatformerPro.Input.

◆ GetButtonState()

virtual ButtonState PlatformerPro.UnityInput.GetButtonState ( string button )

protectedvirtual

Returns the button state (DOWN, UP, HELD, or NONE), for the button defined in the Unity Input Manager

Parameters

button Name of the button defined in the Unity Input Manager

Returns: ButtonState

◆ GetKeyForType()

override KeyCode PlatformerPro.UnityInput.GetKeyForType	(	KeyType	type,
		int	keyNumber
	)

virtual

Gets the key code for the given type.

Returns: The mathcing KeyCode or keyCode.None if there is no match.

Parameters

type	Key type.
keyNumber	Key number if this is an action key (ignored otherwise).

Implements PlatformerPro.Input.

◆ LoadInputData() [1/2]

override void PlatformerPro.UnityInput.LoadInputData ( StandardInputData data )

virtual

Loads the provided input data.

Parameters

data	Data to load.

Implements PlatformerPro.Input.

◆ LoadInputData() [2/2]

override bool PlatformerPro.UnityInput.LoadInputData ( string dataName )

virtual

Loads the input data.

Returns: true, if input data was loaded, false otherwise.

Parameters

dataName Data name.

Implements PlatformerPro.Input.

◆ SaveInputData()

override bool PlatformerPro.UnityInput.SaveInputData ( )

virtual

Saves the input data.

Returns: true

false

Implements PlatformerPro.Input.

◆ SetAxis()

override bool PlatformerPro.UnityInput.SetAxis	(	KeyType	type,
		string	axis,
		bool	reverseAxis
	)

virtual

Sets the joystick axis that corresponds to a Platform PRO input axis.

Returns: true, if key was set, false otherwise.

Parameters

type	Type of key being set.
axis	Unity axis name.

Implements PlatformerPro.Input.

◆ SetKey() [1/2]

override bool PlatformerPro.UnityInput.SetKey	(	KeyType	type,
		KeyCode	keyCode
	)

virtual

Sets the keyboayrd key that corresponds to a Platform PRO input key.

Returns: true, if key was set, false otherwise.

Parameters

type	Type of key being set.
keyCode	Unity key code.

Implements PlatformerPro.Input.

◆ SetKey() [2/2]

override bool PlatformerPro.UnityInput.SetKey	(	KeyType	type,
		KeyCode	keyCode,
		int	keyNumber
	)

virtual

Sets the keyboayrd key that corresponds to a Platform PRO input key.

Returns: true, if key was set, false otherwise.

Parameters

type	Type of key being set.
keyNumber	The action key number or ignored if not setting an action key

Implements PlatformerPro.Input.

Member Data Documentation

◆ actionButtons

string [] PlatformerPro.UnityInput.actionButtons

The action buttons defined in the Unity Input Manager with the first value in the array being the default.

◆ horizontalAxisName

string PlatformerPro.UnityInput.horizontalAxisName = "Horizontal"

String name of the Horizontal axis defined in the Unity Input Manager

◆ jumpButtonName

string PlatformerPro.UnityInput.jumpButtonName = "Jump"

String name of the JUMP button defined in the Unity Input Manager

◆ pauseButtonName

string PlatformerPro.UnityInput.pauseButtonName = "Pause"

String name of the PAUSE button defined in the Unity Input Manager

◆ runButtonName

string PlatformerPro.UnityInput.runButtonName = "Fire1"

String name of the RUN button defined in the Unity Input Manager

◆ verticalAxisName

string PlatformerPro.UnityInput.verticalAxisName = "Vertical"

String name of the Vertical axis defined in the Unity Input Manager

Property Documentation

◆ ActionButton

override ButtonState PlatformerPro.UnityInput.ActionButton

get

ActionButton

◆ AltHorizontalAxis

override float PlatformerPro.UnityInput.AltHorizontalAxis

get

A float value clamped between -1 for completely left and 1 for compeletely right. 0.5f would mean "half right". The exact interpretation of the values is up to the movement behaviours.

◆ AltHorizontalAxisDigital

override int PlatformerPro.UnityInput.AltHorizontalAxisDigital

get

A "digital" version of the alternate horizontal axis in which the only valid values are -1 for LEFT, 0 for NONE, and 1 for RIGHT.

◆ AltHorizontalAxisState

override ButtonState PlatformerPro.UnityInput.AltHorizontalAxisState

get

Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0.

◆ AltVerticalAxis

override float PlatformerPro.UnityInput.AltVerticalAxis

get

A float value clamped between -1 for completely DOWN and 1 for completely UP. 0.5f would mean "half up". The exact interpretation of the values is up to the movement behaviours.

◆ AltVerticalAxisDigital

override int PlatformerPro.UnityInput.AltVerticalAxisDigital

get

A "digital" version of the vertical axis in which the only valid values are -1 for DOWN, 0 for NONE, and 1 for UP.

◆ AltVerticalAxisState

override ButtonState PlatformerPro.UnityInput.AltVerticalAxisState

get

Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value. Return ButtonState.UP if the axis state went from != 0 to 0.

◆ AnyKey

override bool PlatformerPro.UnityInput.AnyKey

get

Returns true if any button or action key is being pressed.

true if any key; otherwise, false.

◆ HorizontalAxis

override float PlatformerPro.UnityInput.HorizontalAxis

get

HorizontalAxis

◆ HorizontalAxisDigital

override int PlatformerPro.UnityInput.HorizontalAxisDigital

get

HorizontalAxisDigital

◆ HorizontalAxisState

override ButtonState PlatformerPro.UnityInput.HorizontalAxisState

get

Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value and wasn't 0; Return ButtonState.UP if the axis state went from != 0 to 0.

◆ JumpButton

override ButtonState PlatformerPro.UnityInput.JumpButton

get

JumpButton

◆ PauseButton

override ButtonState PlatformerPro.UnityInput.PauseButton

get

PauseButton

◆ RunButton

override ButtonState PlatformerPro.UnityInput.RunButton

get

RunButton

◆ VerticalAxis

override float PlatformerPro.UnityInput.VerticalAxis

get

VerticalAxis

◆ VerticalAxisDigital

override int PlatformerPro.UnityInput.VerticalAxisDigital

get

VerticalAxisDigital

◆ VerticalAxisState

override ButtonState PlatformerPro.UnityInput.VerticalAxisState

get

Return ButtonState.DOWN if the axis state went from <= 0 to 1 or >= 0 to -1. Return ButtonState.HELD if the axis stayed at the same value and wasn't 0; Return ButtonState.UP if the axis state went from != 0 to 0.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Input/UnityInput.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ForceButtonState()

◆ GetActionButtonState()

◆ GetAxisForType()

◆ GetButtonState()

◆ GetKeyForType()

◆ LoadInputData() [1/2]

◆ LoadInputData() [2/2]

◆ SaveInputData()

◆ SetAxis()

◆ SetKey() [1/2]

◆ SetKey() [2/2]

Member Data Documentation

◆ actionButtons

◆ horizontalAxisName

◆ jumpButtonName

◆ pauseButtonName

◆ runButtonName

◆ verticalAxisName

Property Documentation

◆ ActionButton

◆ AltHorizontalAxis

◆ AltHorizontalAxisDigital

◆ AltHorizontalAxisState

◆ AltVerticalAxis

◆ AltVerticalAxisDigital

◆ AltVerticalAxisState

◆ AnyKey

◆ HorizontalAxis

◆ HorizontalAxisDigital

◆ HorizontalAxisState

◆ JumpButton

◆ PauseButton

◆ RunButton

◆ VerticalAxis

◆ VerticalAxisDigital

◆ VerticalAxisState