InControl API Reference
BindingListenOptions Class Reference

Public Member Functions

bool CallOnBindingFound (PlayerAction playerAction, BindingSource bindingSource)
 
void CallOnBindingAdded (PlayerAction playerAction, BindingSource bindingSource)
 
void CallOnBindingRejected (PlayerAction playerAction, BindingSource bindingSource, BindingSourceRejectionType bindingSourceRejectionType)
 
void CallOnBindingEnded (PlayerAction playerAction)
 

Public Attributes

bool IncludeControllers = true
 Include controllers when listening for new bindings. More...
 
bool IncludeUnknownControllers = false
 Include unknown controllers when listening for new bindings. More...
 
bool IncludeNonStandardControls = true
 Include non-standard controls on controllers when listening for new bindings. More...
 
bool IncludeMouseButtons = false
 Include mouse buttons when listening for new bindings. More...
 
bool IncludeMouseScrollWheel = false
 Include mouse scroll wheel when listening for new bindings. More...
 
bool IncludeKeys = true
 Include keyboard keys when listening for new bindings. More...
 
bool IncludeModifiersAsFirstClassKeys = false
 Treat modifiers (Shift, Alt, Control, etc.) as first class keys instead of modifiers. More...
 
uint MaxAllowedBindings = 0
 The maximum number of bindings allowed for the action. If a new binding is detected and would cause this number to be exceeded, enough bindings are removed to make room before adding the new binding. When zero (default), no limit is applied. More...
 
uint MaxAllowedBindingsPerType = 0
 The maximum number of bindings of a given type allowed for the action. If a new binding is detected and would cause this number to be exceeded, enough bindings are removed to make room before adding the new binding. When zero (default), no limit is applied. When nonzero, this setting overrides MaxAllowedBindings. More...
 
bool AllowDuplicateBindingsPerSet = false
 Allow bindings that are already bound to any other action in the set. More...
 
bool UnsetDuplicateBindingsOnSet = false
 If an existing duplicate binding exists, remove it before adding the new one. When More...
 
bool RejectRedundantBindings = false
 If an existing duplicate binding already exists on the same action, reject the binding instead of accepting it doing nothing. More...
 
BindingSource ReplaceBinding = null
 If not More...
 
Func< PlayerAction, BindingSource, bool > OnBindingFound = null
 This function is called when a binding is found but before it is added. If this function returns More...
 
Action< PlayerAction, BindingSourceOnBindingAdded = null
 This action is called after a binding is added. If set to More...
 
Action< PlayerAction, BindingSource, BindingSourceRejectionType > OnBindingRejected = null
 This action is called after a binding is found, but rejected along with the reason (BindingSourceRejectionType) why it was rejected. If set to More...
 
Action< PlayerActionOnBindingEnded = null
 This action is called after listening for bindings is ended (for any reason). If set to More...
 

Member Data Documentation

◆ AllowDuplicateBindingsPerSet

bool AllowDuplicateBindingsPerSet = false

Allow bindings that are already bound to any other action in the set.

◆ IncludeControllers

bool IncludeControllers = true

Include controllers when listening for new bindings.

◆ IncludeKeys

bool IncludeKeys = true

Include keyboard keys when listening for new bindings.

◆ IncludeModifiersAsFirstClassKeys

bool IncludeModifiersAsFirstClassKeys = false

Treat modifiers (Shift, Alt, Control, etc.) as first class keys instead of modifiers.

◆ IncludeMouseButtons

bool IncludeMouseButtons = false

Include mouse buttons when listening for new bindings.

◆ IncludeMouseScrollWheel

bool IncludeMouseScrollWheel = false

Include mouse scroll wheel when listening for new bindings.

◆ IncludeNonStandardControls

bool IncludeNonStandardControls = true

Include non-standard controls on controllers when listening for new bindings.

◆ IncludeUnknownControllers

bool IncludeUnknownControllers = false

Include unknown controllers when listening for new bindings.

◆ MaxAllowedBindings

uint MaxAllowedBindings = 0

The maximum number of bindings allowed for the action. If a new binding is detected and would cause this number to be exceeded, enough bindings are removed to make room before adding the new binding. When zero (default), no limit is applied.

◆ MaxAllowedBindingsPerType

uint MaxAllowedBindingsPerType = 0

The maximum number of bindings of a given type allowed for the action. If a new binding is detected and would cause this number to be exceeded, enough bindings are removed to make room before adding the new binding. When zero (default), no limit is applied. When nonzero, this setting overrides MaxAllowedBindings.

◆ OnBindingAdded

Action<PlayerAction, BindingSource> OnBindingAdded = null

This action is called after a binding is added. If set to

null (default), it will not be called.

◆ OnBindingEnded

Action<PlayerAction> OnBindingEnded = null

This action is called after listening for bindings is ended (for any reason). If set to

null (default), it will not be called.

◆ OnBindingFound

Func<PlayerAction, BindingSource, bool> OnBindingFound = null

This function is called when a binding is found but before it is added. If this function returns

false, then the binding is ignored and listening for new bindings will continue. If set to null (default), it will not be called.

◆ OnBindingRejected

Action<PlayerAction, BindingSource, BindingSourceRejectionType> OnBindingRejected = null

This action is called after a binding is found, but rejected along with the reason (BindingSourceRejectionType) why it was rejected. If set to

null (default), it will not be called.

◆ RejectRedundantBindings

bool RejectRedundantBindings = false

If an existing duplicate binding already exists on the same action, reject the binding instead of accepting it doing nothing.

◆ ReplaceBinding

BindingSource ReplaceBinding = null

If not

null, and this binding is on the listening action, this binding will be replace by the newly found binding.

◆ UnsetDuplicateBindingsOnSet

bool UnsetDuplicateBindingsOnSet = false

If an existing duplicate binding exists, remove it before adding the new one. When

true, the value of AllowDuplicateBindingsPerSet is irrelevant.


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