PlayerControllerAxis Class |
An Axis that uses Player Actions as the value source.
Inheritance HierarchySystemObject
RewiredPlayerControllerElement
RewiredPlayerControllerElementWithSource
RewiredPlayerControllerAxis
RewiredPlayerControllerMouseAxis
RewiredPlayerControllerMouseWheelAxis
RewiredPlayerControllerElement
RewiredPlayerControllerElementWithSource
RewiredPlayerControllerAxis
RewiredPlayerControllerMouseAxis
RewiredPlayerControllerMouseWheelAxis
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class Axis : PlayerControllerElementWithSource
The PlayerControllerAxis type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | absoluteToRelativeSensitivity |
The absolute to relative sensitivity multiplier. This is only applied when the axis coordinate mode is set to Relative and the axis receives
Absolute coordinate mode input (joystick axes, keyboard keys, etc.).
|
| actionId |
The Action id of the Action which will be used as the input source for the Element.
(Inherited from PlayerControllerElementWithSource.) |
| actionName |
The Action name of the Action which will be used as the input source for the Element.
(Inherited from PlayerControllerElementWithSource.) |
| coordinateMode |
The output coordinate mode of the axis. An Absolute axis will only return value for input received from Absolute sources.
A Relative axis will return value for input received from both Relative and Absolute sources. When converting from
an Absolute input source to a Relative output, absoluteToRelativeSensitivity will be multiplied by the Absolute value
to yield a simulated Relative value.
|
| enabled |
Is this element enabled? Disabled elements return no value.
(Inherited from PlayerControllerElement.) |
| name |
The name of the element.
(Inherited from PlayerControllerElement.) |
| value |
The current value.
|
| valueRaw |
The current raw value.
This is the same as getting the raw axis value from Player.GetAxisRaw.
|
See Also