Input which accepts input form multiple sources and provides an interface that makes them look like one source. More...

Inheritance diagram for PlatformerPro.MultiInput:

Public Member Functions
override ButtonState	GetActionButtonState (int buttonIndex)
	Get the state of an action button. More...

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

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

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

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

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

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

override bool	SaveInputData ()
	Saves the input data. NOT AVAILABLE in MultiInput. More...

override bool	LoadInputData (string dataName)
	Loads the input data for the given data name. NOT AVAILABLE in MultiInput. More...

override void	LoadInputData (StandardInputData data)
	Loads the input data for the given data name. NOT AVAILABLE in MultiInput. More...

override void	ConsumeJumpButton ()
	Consumes a jump button down event converting it in to a button held event. More...

override void	ConsumeRunButton ()
	Consumes a run button down event converting it in to a button held event. More...

override void	ConsumeActionButton (int index)
	Consumes an action button down event converting it in to a button held event. 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
Input[]	inputs
	An ordered list of inputs. Highest in the list is given priority. More...

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

Properties
override 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...

override 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...

override ButtonState	HorizontalAxisState `[get]`
	Gets the state of the horizontal axis. More...

override 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...

override 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...

override ButtonState	VerticalAxisState `[get]`
	Gets the state of the vertical axis. 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]`
	Gets the state of the alternate horizontal axis. 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]`
	Gets the state of the alternate vertical axis. More...

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

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

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

override ButtonState	ActionButton `[get]`
	Gets the action button. More...

override bool	AnyKey `[get]`
	Returns true if any button or action key is being pressed. 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

Input which accepts input form multiple sources and provides an interface that makes them look like one source.

Member Function Documentation

◆ ConsumeActionButton()

override void PlatformerPro.MultiInput.ConsumeActionButton ( int index )

virtual

Consumes an action button down event converting it in to a button held event.

Reimplemented from PlatformerPro.Input.

◆ ConsumeJumpButton()

override void PlatformerPro.MultiInput.ConsumeJumpButton ( )

virtual

Consumes a jump button down event converting it in to a button held event.

Reimplemented from PlatformerPro.Input.

◆ ConsumeRunButton()

override void PlatformerPro.MultiInput.ConsumeRunButton ( )

virtual

Consumes a run button down event converting it in to a button held event.

Reimplemented from PlatformerPro.Input.

◆ ForceButtonState()

override void PlatformerPro.MultiInput.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.MultiInput.GetActionButtonState ( int buttonIndex )

virtual

Get the state of an action button.

Returns: The buttons state.

Parameters

buttonIndex The index of the button.

Implements PlatformerPro.Input.

◆ GetAxisForType()

override string PlatformerPro.MultiInput.GetAxisForType ( KeyType type )

virtual

Gets the name of the axis for the given key type. NOT AVAILABLE in MultiInput.

Returns: The axis name.

Parameters

type Type.

Implements PlatformerPro.Input.

◆ GetKeyForType()

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

virtual

Gets the key code for the given type. NOT AVAILABLE in MultiInput.

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.MultiInput.LoadInputData ( StandardInputData data )

virtual

Loads the input data for the given data name. NOT AVAILABLE in MultiInput.

Returns: true

false

Parameters

dataName	Data to load.
data	Data.

Implements PlatformerPro.Input.

◆ LoadInputData() [2/2]

override bool PlatformerPro.MultiInput.LoadInputData ( string dataName )

virtual

Loads the input data for the given data name. NOT AVAILABLE in MultiInput.

Returns: true

false

Parameters

dataName Data to load.

Implements PlatformerPro.Input.

◆ SaveInputData()

override bool PlatformerPro.MultiInput.SaveInputData ( )

virtual

Saves the input data. NOT AVAILABLE in MultiInput.

Returns: true

false

Implements PlatformerPro.Input.

◆ SetAxis()

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

virtual

Sets the joystick axis that corresponds to a Platform PRO input axis. NOT AVAILABLE in MultiInput.

Returns: true

false

Parameters

type	Type of key being set.
axis	Unity axis name.
reverseAxis	Should axis values be reversed.

Implements PlatformerPro.Input.

◆ SetKey() [1/2]

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

virtual

Sets the keyboayrd key that corresponds to a Platform PRO input key. NOT AVAILABLE in MultiInput.

Returns: true

false

Parameters

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

Implements PlatformerPro.Input.

◆ SetKey() [2/2]

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

virtual

Sets the keyboayrd key that corresponds to a Platform PRO input key. NOT AVAILABLE in MultiInput.

Returns: true

false

Parameters

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

Implements PlatformerPro.Input.

Member Data Documentation

◆ inputs

Input [] PlatformerPro.MultiInput.inputs

An ordered list of inputs. Highest in the list is given priority.

Property Documentation

◆ ActionButton

override ButtonState PlatformerPro.MultiInput.ActionButton

get

Gets the action button.

The action button.

◆ AltHorizontalAxis

override float PlatformerPro.MultiInput.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.

The alternate horizontal axis.

◆ AltHorizontalAxisDigital

override int PlatformerPro.MultiInput.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.

The alternate horizontal axis digital.

◆ AltHorizontalAxisState

override ButtonState PlatformerPro.MultiInput.AltHorizontalAxisState

get

Gets the state of the alternate horizontal axis.

The state of the alternate horizontal axis.

◆ AltVerticalAxis

override float PlatformerPro.MultiInput.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.

The alternate vertical axis.

◆ AltVerticalAxisDigital

override int PlatformerPro.MultiInput.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.

The alternate vertical axis digital.

◆ AltVerticalAxisState

override ButtonState PlatformerPro.MultiInput.AltVerticalAxisState

get

Gets the state of the alternate vertical axis.

The state of the alternate vertical axis.

◆ AnyKey

override bool PlatformerPro.MultiInput.AnyKey

get

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

true

false

◆ HorizontalAxis

override float PlatformerPro.MultiInput.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.

The horizontal axis.

◆ HorizontalAxisDigital

override int PlatformerPro.MultiInput.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.

The horizontal axis digital.

◆ HorizontalAxisState

override ButtonState PlatformerPro.MultiInput.HorizontalAxisState

get

Gets the state of the horizontal axis.

The state of the horizontal axis.

◆ JumpButton

override ButtonState PlatformerPro.MultiInput.JumpButton

get

State of the jump button.

The jump button.

◆ PauseButton

override ButtonState PlatformerPro.MultiInput.PauseButton

get

State of the pause button.

The pause button.

◆ RunButton

override ButtonState PlatformerPro.MultiInput.RunButton

get

State of the run button.

The run button.

◆ VerticalAxis

override float PlatformerPro.MultiInput.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.

The vertical axis.

◆ VerticalAxisDigital

override int PlatformerPro.MultiInput.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.

The vertical axis digital.

◆ VerticalAxisState

override ButtonState PlatformerPro.MultiInput.VerticalAxisState

get

Gets the state of the vertical axis.

The state of the vertical axis.

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

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

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ ConsumeActionButton()

◆ ConsumeJumpButton()

◆ ConsumeRunButton()

◆ ForceButtonState()

◆ GetActionButtonState()

◆ GetAxisForType()

◆ GetKeyForType()

◆ LoadInputData() [1/2]

◆ LoadInputData() [2/2]

◆ SaveInputData()

◆ SetAxis()

◆ SetKey() [1/2]

◆ SetKey() [2/2]

Member Data Documentation

◆ inputs

Property Documentation

◆ ActionButton

◆ AltHorizontalAxis

◆ AltHorizontalAxisDigital

◆ AltHorizontalAxisState

◆ AltVerticalAxis

◆ AltVerticalAxisDigital

◆ AltVerticalAxisState

◆ AnyKey

◆ HorizontalAxis

◆ HorizontalAxisDigital

◆ HorizontalAxisState

◆ JumpButton

◆ PauseButton

◆ RunButton

◆ VerticalAxis

◆ VerticalAxisDigital

◆ VerticalAxisState