Inheritance
ActionMapInput
public class ActionMapInput : InputControlProvider
Constructors
Declaration
protected ActionMapInput(ActionMap actionMap)
Parameters
Fields
Declaration
public static ActionMapInput.ChangeEvent onStatusChange
Field Value
Properties
Declaration
public ActionMap actionMap { get; }
Property Value
Declaration
public override bool active { get; set; }
Property Value
Overrides
Control whether this ActionMapInput will attempt to reinitialize with applicable devices in order to process events
Declaration
public bool autoReinitialize { get; set; }
Property Value
Declaration
public bool blockSubsequent { get; set; }
Property Value
Declaration
public ControlScheme controlScheme { get; }
Property Value
Declaration
public bool resetOnActiveChanged { get; set; }
Property Value
Methods
Declaration
Declaration
public bool BindControl(InputControlDescriptor descriptor, InputControl control, bool restrictToExistingDevices)
Parameters
Returns
Declaration
public static ActionMapInput Create(ActionMap actionMap)
Parameters
Returns
Declaration
public bool CurrentlyUsesDevice(InputDevice device)
Parameters
Returns
Declaration
Declaration
public List<InputDevice> GetCurrentlyUsedDevices()
Returns
Declaration
public override string GetPrimarySourceName(int controlIndex, string buttonAxisFormattingString = "{0} & {1}")
Parameters
| Type |
Name |
Description |
| Int32 |
controlIndex |
|
| String |
buttonAxisFormattingString |
|
Returns
Overrides
Declaration
public override bool ProcessEvent(InputEvent inputEvent)
Parameters
Returns
Overrides
Declaration
public void Reset(bool initToDeviceState = true)
Parameters
| Type |
Name |
Description |
| Boolean |
initToDeviceState |
|
Reset controls that share the same source (potentially from another AMI)
Declaration
public void ResetControl(InputControl control)
Parameters
Declaration
public void RevertCustomizations()
Find the best control scheme for the available devices and initialize the action map input.
It's important to note that an action map that can use either of two devices should have two of the same device
listed in the control scheme. Otherwise, if the ActionMapInput is initialized with those two devices, the first
device state found will override the other's device state. This becomes apparent when GetDeviceStateForDeviceSlot
is called.
Ex. Having a left and right VR controller where the action map can accept either controller's trigger button
would cause issues if only one device was listed in the action map. Usually, this shows up as a ping-ponging
issue where the ActionMapInput keeps getting re-initialized and binds different devices.
Declaration
public bool TryInitializeWithDevices(IEnumerable<InputDevice> availableDevices, IEnumerable<InputDevice> requiredDevices = null)
Parameters
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.