A control made up of four discrete, directional buttons. Forms a vector
but can also be addressed as individual buttons.
Inheritance
System.Object
DpadControl
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
public class DpadControl : InputControl<Vector2>
Constructors
Declaration
Properties
The button representing the vertical downwards state of the D-Pad.
Declaration
public ButtonControl down { get; }
Property Value
The button representing the horizontal left state of the D-Pad.
Declaration
public ButtonControl left { get; }
Property Value
The button representing the horizontal right state of the D-Pad.
Declaration
public ButtonControl right { get; }
Property Value
The button representing the vertical upwards state of the D-Pad.
Declaration
public ButtonControl up { get; }
Property Value
Methods
Declaration
protected override void FinishSetup(InputDeviceBuilder builder)
Parameters
Type |
Name |
Description |
InputDeviceBuilder |
builder |
|
Overrides
Create a direction vector from the given four button states.
Declaration
public static Vector2 MakeDpadVector(bool up, bool down, bool left, bool right, bool normalize = true)
Parameters
Type |
Name |
Description |
System.Boolean |
up |
|
System.Boolean |
down |
|
System.Boolean |
left |
|
System.Boolean |
right |
|
System.Boolean |
normalize |
|
Returns
Type |
Description |
Vector2 |
A normalized 2D direction vector.
|
Declaration
public override Vector2 ReadUnprocessedValueFromState(void *statePtr)
Parameters
Type |
Name |
Description |
System.Void* |
statePtr |
|
Returns
Overrides
UnityEngine.Experimental.Input.InputControl<Vector2>.ReadUnprocessedValueFromState(System.Void*)
Declaration
public override void WriteValueIntoState(Vector2 value, void *statePtr)
Parameters
Type |
Name |
Description |
Vector2 |
value |
|
System.Void* |
statePtr |
|
Overrides
UnityEngine.Experimental.Input.InputControl<Vector2>.WriteValueIntoState(Vector2, System.Void*)
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.