Inheritance
InputControlLayout
public class InputControlLayout
Fields
Declaration
public const string VariantSeparator = ";"
Field Value
Properties
Declaration
public IEnumerable<InternedString> appliedOverrides { get; }
Property Value
Declaration
public IEnumerable<InternedString> baseLayouts { get; }
Property Value
Declaration
public bool? canRunInBackground { get; }
Property Value
Declaration
public ReadOnlyArray<InternedString> commonUsages { get; }
Property Value
List of child controls defined for the layout.
Declaration
public ReadOnlyArray<InputControlLayout.ControlItem> controls { get; }
Property Value
Declaration
public static InternedString DefaultVariant { get; }
Property Value
Declaration
public string displayName { get; }
Property Value
Declaration
public bool hideInUI { get; }
Property Value
Declaration
public bool isControlLayout { get; }
Property Value
Declaration
public bool isDeviceLayout { get; }
Property Value
Declaration
public bool isGenericTypeOfDevice { get; }
Property Value
Mark the input device created from this layout as noisy, irrespective of whether or not any
of its controls have been marked as noisy.
Declaration
public bool isNoisy { get; }
Property Value
Whether the layout is applies overrides to other layouts instead of
defining a layout by itself.
Declaration
public bool isOverride { get; }
Property Value
Type |
Description |
Boolean |
True if the layout acts as an override.
|
Declaration
public InputControlLayout.ControlItem this[string path] { get; }
Parameters
Type |
Name |
Description |
String |
path |
|
Property Value
Declaration
public InternedString name { get; }
Property Value
Declaration
public FourCC stateFormat { get; }
Property Value
Declaration
public int stateSizeInBytes { get; }
Property Value
Declaration
public Type type { get; }
Property Value
Declaration
public bool updateBeforeRender { get; }
Property Value
Declaration
public InternedString variants { get; }
Property Value
Methods
Declaration
public InputControlLayout.ControlItem? FindControl(InternedString path)
Parameters
Returns
Declaration
public InputControlLayout.ControlItem? FindControlIncludingArrayElements(string path, out int arrayIndex)
Parameters
Returns
Declaration
public static InputControlLayout FromJson(string json)
Parameters
Type |
Name |
Description |
String |
json |
|
Returns
Declaration
public static InputControlLayout FromType(string name, Type type)
Parameters
Returns
Return the type of values produced by controls created from the layout.
Declaration
public Type GetValueType()
Returns
Type |
Description |
Type |
The value type of the control or null if it cannot be determined.
|
Merge the settings from other
into the layout such that they become
the base settings.
Declaration
public void MergeLayout(InputControlLayout other)
Parameters
Declaration
Returns
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.