InputBinding Interface Reference

Public Member Functions
proto external void	ResetDefault (string actionName, EInputDeviceType deviceType=EInputDeviceType.INVALID, string preset=string.Empty)
proto external bool	IsDefault (string actionName, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty)
proto external bool	CreateUserBinding (string actionName, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty)
proto external int	GetBindingsCount (string actionName, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty)
proto external void	RemoveBinding (string actionName, EInputDeviceType deviceType, string preset, int keyBindIndex)
proto external void	AddBinding (string actionName, string preset, string keyBinding, string filterName=string.Empty)
proto external void	InsertCombo (string actionName, string preset, string keyBinding, string filterName, int keyBindIndex, int comboIndex=-1)
proto external bool	SetFilter (string actionName, EInputDeviceType deviceType, string preset, int keyBindIndex, string filterName)
proto external string	GetFilter (string actionName, EInputDeviceType deviceType, string preset, int keyBindIndex)
proto external void	StartCapture (string actionName, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty, bool bAppend=false, EInputBindingAxleCapture eAxleCapture=EInputBindingAxleCapture.HALF_AXLE)
proto external void	GetCustomConfigs (out notnull array< ResourceName > customConfigs)
proto external void	SetCustomConfigs (notnull array< ResourceName > customConfigs)
proto external void	CancelCapture ()
proto external void	SaveCapture (array< string > additionalKeyBindings=null)
	Additional key bindings can be added using additionalKeyBindings array.
proto external EInputBindingCaptureState	GetCaptureState ()
proto external BaseContainer	FindContext (string contextName)
proto external BaseContainer	FindAction (string actionName)
proto external void	StartCalibration (EInputDeviceType deviceType)
	Start calibration process for device type.
proto external void	StopCalibration ()
	Cancel running calibration process.
proto external EInputBindingCalibrationStatus	GetCalibrationStatus ()
	Return status of calibration process.
proto external bool	GetCalibrationData (EInputBindingCalibrationData dataType, out vector min, out vector max)
	Get specific min & max calibration data.
proto external void	Save ()
proto external bool	GetConflicts (string actionName, out notnull array< int > keyBindIndices, out notnull array< string > conflictedActions, out notnull array< string > conflictedActionPresets, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty)
proto external bool	GetBindings (string actionName, out notnull array< string > bindings, EInputDeviceType deviceType=EInputDeviceType.KEYBOARD, string preset=string.Empty)
proto external void	GetContexts (out array< string > contextNames)
proto external void	GetPresets (string actionName, out array< string > presetNames)

Member Function Documentation

AddBinding()

proto external void InputBinding.AddBinding	(	string	actionName,
		string	preset,
		string	keyBinding,
		string	filterName = string.Empty )

CancelCapture()

proto external void InputBinding.CancelCapture

(

)

CreateUserBinding()

proto external bool InputBinding.CreateUserBinding	(	string	actionName,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty )

FindAction()

proto external BaseContainer InputBinding.FindAction

(

string

actionName

)

FindContext()

proto external BaseContainer InputBinding.FindContext

(

string

contextName

)

GetBindings()

proto external bool InputBinding.GetBindings	(	string	actionName,
		out notnull array< string >	bindings,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty )

GetBindingsCount()

proto external int InputBinding.GetBindingsCount	(	string	actionName,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty )

GetCalibrationData()

proto external bool InputBinding.GetCalibrationData	(	EInputBindingCalibrationData	dataType,
		out vector	min,
		out vector	max )

Get specific min & max calibration data.

GetCalibrationStatus()

proto external EInputBindingCalibrationStatus InputBinding.GetCalibrationStatus

(

)

Return status of calibration process.

GetCaptureState()

proto external EInputBindingCaptureState InputBinding.GetCaptureState

(

)

GetConflicts()

proto external bool InputBinding.GetConflicts	(	string	actionName,
		out notnull array< int >	keyBindIndices,
		out notnull array< string >	conflictedActions,
		out notnull array< string >	conflictedActionPresets,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty )

GetContexts()

proto external void InputBinding.GetContexts

(

out array< string >

contextNames

)

GetCustomConfigs()

proto external void InputBinding.GetCustomConfigs

(

out notnull array< ResourceName >

customConfigs

)

GetFilter()

proto external string InputBinding.GetFilter	(	string	actionName,
		EInputDeviceType	deviceType,
		string	preset,
		int	keyBindIndex )

GetPresets()

proto external void InputBinding.GetPresets	(	string	actionName,
		out array< string >	presetNames )

InsertCombo()

proto external void InputBinding.InsertCombo	(	string	actionName,
		string	preset,
		string	keyBinding,
		string	filterName,
		int	keyBindIndex,
		int	comboIndex = -1 )

IsDefault()

proto external bool InputBinding.IsDefault	(	string	actionName,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty )

RemoveBinding()

proto external void InputBinding.RemoveBinding	(	string	actionName,
		EInputDeviceType	deviceType,
		string	preset,
		int	keyBindIndex )

ResetDefault()

proto external void InputBinding.ResetDefault	(	string	actionName,
		EInputDeviceType	deviceType = EInputDeviceType.INVALID,
		string	preset = string.Empty )

Save()

proto external void InputBinding.Save

(

)

SaveCapture()

proto external void InputBinding.SaveCapture

(

array< string >

additionalKeyBindings = null

)

Additional key bindings can be added using additionalKeyBindings array.

SetCustomConfigs()

proto external void InputBinding.SetCustomConfigs

(

notnull array< ResourceName >

customConfigs

)

SetFilter()

proto external bool InputBinding.SetFilter	(	string	actionName,
		EInputDeviceType	deviceType,
		string	preset,
		int	keyBindIndex,
		string	filterName )

StartCalibration()

proto external void InputBinding.StartCalibration

(

EInputDeviceType

deviceType

)

Start calibration process for device type.

StartCapture()

proto external void InputBinding.StartCapture	(	string	actionName,
		EInputDeviceType	deviceType = EInputDeviceType.KEYBOARD,
		string	preset = string.Empty,
		bool	bAppend = false,
		EInputBindingAxleCapture	eAxleCapture = EInputBindingAxleCapture.HALF_AXLE )

StopCalibration()

proto external void InputBinding.StopCalibration

(

)

Cancel running calibration process.

---

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

• GameLib/generated/Input/InputBinding.c