Player |
A controller that uses Player Actions as the input sources for controller elements.
Inheritance HierarchyNamespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class PlayerController
The PlayerController type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | absoluteToRelativeScalingReferenceResolution | The reference resolution for absolute to relative value scaling. This is used in conjunction with absoluteToRelativeScalingMode to determine how to scale absolute values to relative values. When absoluteToRelativeScalingMode is set to any of the screen / viewport scaling modes, if the scaling mode is based on the horizontal dimension of the screen / viewport, the horizontal resolution will be divided by the reference X resolution to determine the final scaling factor. For example, if the horizontal reference resolution is 1920 pixels and the current screen / viewport horizontal resolution is 3840 pixels, the final scaling multiplier will be 2, resulting in a doubling of value to compensate for the increased resolution. If the scaling mode is based on the vertical dimension of the screen / viewport, the vertical resolution will be divided by the reference Y resolution to determine the final scaling factor. For example, if the vertical reference resolution is 1080 pixels and the current screen / viewport horizontal resolution is 720 pixels, the final scaling multiplier will be 0.66667, resulting in a reduction of value to compensate for the decreased resolution. [Default = 1920x1080] |
| axes | The list of Axes in the controller. |
| axisCount | The number of Axes in the controller. |
| buttonCount | The number of Buttons in the controller. |
| buttons | The list of Buttons in the controller. |
| elementCount | The number of Elements in the controller. |
| elements | The list of Elements of all types in the controller. |
| enabled | Is the controller enabled? |
| playerId | The Player id of the Player used for the source of input. |
Methods| Name | Description | |
|---|---|---|
 | GetAxis | Gets the current axis value. |
| GetAxisRaw | Gets the current raw axis value. |
| GetButton | Gets the current value of the button. |
| GetButtonDown | Gets the down state of the button. Returns True only on the first frame the button was pressed. |
| GetButtonUp | Gets the up state of the button. Returns True only on the first frame the button was released. |
| GetElement(Int32) | Gets the element at the specified index. |
| GetElementT(Int32) | Gets the element at the specified index. |
Events| Name | Description | |
|---|---|---|
 | AxisValueChangedEvent | Triggered when the axis value changes. |
| ButtonStateChangedEvent | Triggered the first frame the button is pressed or released. |
| EnabledStateChangedEvent | Triggered when the controller is enabled or disabled. |
See Also