A mapping of control input to an action.
[Serializable]
public struct InputBinding : IEquatable<InputBinding>
Fields
Declaration
public const char Separator = ';'
Field Value
Type |
Description |
System.Char |
|
Properties
Name or ID of the action triggered by the binding.
Declaration
public string action { get; set; }
Property Value
Type |
Description |
System.String |
|
This is the interaction config which is effectively being used.
Declaration
public string effectiveInteractions { get; }
Property Value
Type |
Description |
System.String |
|
This is the bindings path which is effectively being used.
Declaration
public string effectivePath { get; }
Property Value
Type |
Description |
System.String |
|
This is the processor config which is effectively being used.
Declaration
public string effectiveProcessors { get; }
Property Value
Type |
Description |
System.String |
|
Declaration
public string groups { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public Guid id { get; set; }
Property Value
Type |
Description |
System.Guid |
|
Optional list of interactions and their parameters.
Declaration
public string interactions { get; set; }
Property Value
Type |
Description |
System.String |
|
"tap,slowTap(duration=1.2)"
Declaration
public bool isComposite { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public bool isPartOfComposite { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Optional name for the binding.
Declaration
public string name { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public string overrideInteractions { get; set; }
Property Value
Type |
Description |
System.String |
|
If the binding is overridden, this is the overriding path.
Otherwise it is null.
Declaration
public string overridePath { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public string overrideProcessors { get; set; }
Property Value
Type |
Description |
System.String |
|
Control path being bound to.
Declaration
public string path { get; set; }
Property Value
Type |
Description |
System.String |
|
"/*/{PrimaryAction}"
Optional list of processors to apply to control values.
Declaration
public string processors { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
System.Object |
obj |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
System.ValueType.Equals(System.Object)
Declaration
public bool Equals(InputBinding other)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
Overrides
System.ValueType.GetHashCode()
Declaration
public static InputBinding MaskByGroup(string group)
Parameters
Type |
Name |
Description |
System.String |
group |
|
Returns
Declaration
public static InputBinding MaskByGroups(params string[] groups)
Parameters
Type |
Name |
Description |
System.String[] |
groups |
|
Returns
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.ValueType.ToString()
Operators
Declaration
public static bool operator ==(InputBinding left, InputBinding right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static bool operator !=(InputBinding left, InputBinding right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.