SmashHammer.Scripting.InputActionProxy Struct Reference

An input action. More...

Properties
readonly string	PrimaryKeyName [get, set]
	Name of the primary key, if one is bound.
readonly string[]	PrimaryModifierKeyNames [get, set]
	Names of the primary bound modifier keys, if any.
readonly string	SecondaryKeyName [get, set]
	Name of the secondary key, if one is bound.
readonly string[]	SecondaryModifierKeyNames [get, set]
	Names of the secondary bound modifier keys, if any.
readonly bool	IgnoreExtraModifiers [get, set]
	Should extra modifiers be ignored when checking if the input action is triggered or held?
readonly bool	IsBound [get]
	Is the input action bound?
readonly bool	IsTriggered [get]
	Is the input action key triggered?
readonly bool	IsHeld [get]
	Is the input action key held?

Detailed Description

An input action.

Property Documentation

PrimaryKeyName

readonly string SmashHammer.Scripting.InputActionProxy.PrimaryKeyName

getset

Name of the primary key, if one is bound.

The primary key name, "None" if not bound.

PrimaryModifierKeyNames

readonly string [] SmashHammer.Scripting.InputActionProxy.PrimaryModifierKeyNames

getset

Names of the primary bound modifier keys, if any.

The primary modifier key names, nil if none bound.

Only the following are valid modifier key names:

• LeftShift
• RightShift
• LeftControl
• RightControl
• LeftAlt
• RightAlt

SecondaryKeyName

readonly string SmashHammer.Scripting.InputActionProxy.SecondaryKeyName

getset

Name of the secondary key, if one is bound.

The secondary key name, "None" if not bound.

SecondaryModifierKeyNames

readonly string [] SmashHammer.Scripting.InputActionProxy.SecondaryModifierKeyNames

getset

Names of the secondary bound modifier keys, if any.

The secondary modifier key names, nil if none bound.

Only the following are valid modifier key names:

• LeftShift
• RightShift
• LeftControl
• RightControl
• LeftAlt
• RightAlt

IgnoreExtraModifiers

readonly bool SmashHammer.Scripting.InputActionProxy.IgnoreExtraModifiers

getset

Should extra modifiers be ignored when checking if the input action is triggered or held?

true to ignore modifier keys not bound to this input action; otherwise, false.

IsBound

readonly bool SmashHammer.Scripting.InputActionProxy.IsBound

get

Is the input action bound?

true if a key is bound to this input action; otherwise, false.

IsTriggered

readonly bool SmashHammer.Scripting.InputActionProxy.IsTriggered

get

Is the input action key triggered?

true if this input action's key is currently triggered; otherwise, false.

IsHeld

readonly bool SmashHammer.Scripting.InputActionProxy.IsHeld

get

Is the input action key held?

true if this input action's key is currently held; otherwise, false.