Controller Class |
The base class for all controllers.
Inheritance HierarchyNamespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public abstract class Controller
The Controller type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | buttonCount |
The Button count in the controller.
|
| ButtonElementIdentifiers |
Gets a list of all Button element identifiers.
There is always one element identifier per Button
which is at the same index as the corresponding Button.
|
| Buttons |
List of Buttons in this controller.
|
| CompoundElements |
List of all Compound Elements in this controller.
|
| deviceInstanceGuid |
The unique persistent instance GUID of this device.
This is an id generated for the device that may stay constant between application sessions and system restarts.
This can be used for device assignment persistence between runs. The specific platform and input sources in use
affects the reliability of this value for device assignment persistence.
A value of Guid.Empty means the device or input source has no reliable unique identifier so persistant assignment
isn't possible using this value. Even if a Guid is provided, reliability when multiple identical controllers are
attached depends greatly on the platform and input source(s) currently in use.
|
| elementCount |
The Element count in the controller.
|
| ElementIdentifiers |
Gets a list of all element identifiers of all types.
|
| Elements |
List of all Elements in this controller.
|
| enabled |
Is the controller enabled? Disabled controllers return no input.
|
| extension |
Gets an object used to access controller and platform-specific controller functions.
|
| hardwareIdentifier |
String of information from the controller used for identifying unknown controller maps for saving/loading.
|
| hardwareName |
The name the controller hardware returns.
|
| hardwareTypeGuid |
The Rewired GUID associated with this device. A GUID of all zeros is an Unknown Controller.
|
| identifier |
Gets identifying information about the Controller.
|
| isConnected |
Is the controller connected?
|
| mapTypeString |
String representation of the controller map type. Can be used for saving/loading.
|
| name |
The name of the controller.
This is drawn from the controller definition for recognized controllers.
For unrecognized controllers, the name returned by the hardware is used instead.
The returned value will be localized if localization is in use.
|
| tag |
The tag assigned to the controller. Can be used for find a controller by tag.
|
| templateCount |
The Template count in the controller.
|
| Templates |
The Controller Templates that the Controller implements.
|
| type |
The type of this controller.
|
Methods| Name | Description | |
|---|---|---|
 | GetAnyButton |
Gets the button held state of any hardware button. This will return TRUE as long as any button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetAnyButtonChanged |
Returns true if any button has changed state from the previous frame to the current.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetAnyButtonDown |
Gets the button just pressed state of any hardware button. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetAnyButtonPrev |
Gets the previous button held state of any hardware button. This will return TRUE if any button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetAnyButtonUp |
Gets the button just released state of any hardware button. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButton |
Gets the button held state of the hardware button at the specified index. This will return TRUE as long as the button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonById |
Gets the button held state of the hardware button at the specified element identifier id. This will return TRUE as long as the button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonChanged |
Returns true if the button has changed state from the previous frame to the current.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonDoublePressDown(Int32) |
Gets the double press down state of the button at the specified index.
This will return TRUE only on the first frame the double press is detected.
This will use the default double press speed.
|
| GetButtonDoublePressDown(Int32, Single) |
Gets the double press down state of the button at the specified index.
This will return TRUE only on the first frame the double press is detected.
|
| GetButtonDoublePressDownById(Int32) |
Gets the double press down state of the button at the specified element identifier id.
This will return TRUE only on the first frame the double press is detected.
This will use the default double press speed.
|
| GetButtonDoublePressDownById(Int32, Single) |
Gets the double press down state of the button at the specified element identifier id.
This will return TRUE only on the first frame the double press is detected.
|
| GetButtonDoublePressHold(Int32) |
Gets the double press and hold state of the button at the specified index.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
This will use the default double press speed.
|
| GetButtonDoublePressHold(Int32, Single) |
Gets the double press and hold state of the button at the specified index.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
|
| GetButtonDoublePressHoldById(Int32) |
Gets the double press and hold state of the button at the specified element identifier id.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
This will use the default double press speed.
|
| GetButtonDoublePressHoldById(Int32, Single) |
Gets the double press and hold state of the button at the specified element identifier id.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
|
| GetButtonDown |
Gets the button just pressed state of the hardware button at the specified index. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonDownById |
Gets the button just pressed state of the hardware button at the specified element identifier id. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonIndexById |
Gets the index of the Button with the specified element idenfitier id.
|
| GetButtonLastTimePressed |
Gets the last timestamp the button at index was active.
|
| GetButtonLastTimePressedById |
Gets the last timestamp the button with the element identifier id was active.
|
| GetButtonLastTimeUnpressed |
Gets the last timestamp the button at index was inactive.
|
| GetButtonLastTimeUnpressedById |
Gets the last timestamp the button with the element identifier id was inactive.
|
| GetButtonPrev |
Gets the previous button held state of the hardware button at the specified index. This will return TRUE if the button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonPrevById |
Gets the previous button held state of the hardware button at the specified element identifier id. This will return TRUE if the button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonTimePressed |
Gets the length of time the button at index has been active.
|
| GetButtonTimePressedById |
Gets the length of time the button with the element identifier id has been active.
|
| GetButtonTimeUnpressed |
Gets the length of time the button at index has been inactive.
|
| GetButtonTimeUnpressedById |
Gets the length of time the button with the element identifier id has been inactive.
|
| GetButtonUp |
Gets the button just released state of the hardware button at the specified index. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetButtonUpById |
Gets the button just released state of the hardware button at the specified element identifier id. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
|
| GetCompoundElementById |
Gets the Compound Element with the specified element identifier id.
|
| GetCompundElementById | Obsolete.
OBSOLETE: This method is deprecated. Use GetCompoundElementById(Int32) instead.
Gets the Compound Element with the specified element identifier id.
|
| GetElementById |
Gets the Element with the specified element identifier id.
|
| GetElementIdentifierById |
Gets a Controller Element Identifier by id.
|
| GetExtensionT |
Gets an object used to access controller and platform-specific controller functions.
|
| GetLastTimeActive |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
|
| GetLastTimeActive(Boolean) |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
|
| GetLastTimeAnyButtonChanged |
Gets the last timestamp any button's state changed.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
|
| GetLastTimeAnyButtonPressed |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
|
| GetLastTimeAnyElementChanged |
Gets the last timestamp any element changed state.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
|
| GetLastTimeAnyElementChanged(Boolean) |
Gets the last timestamp any element changed state.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Use raw axis values |
| GetTemplate(Guid) |
Gets a Controller Template by type GUID.
|
| GetTemplate(Type) |
Gets a Controller Template by type.
|
| GetTemplateT |
Gets the first Controller Template that implements the specified type.
Note that it is possible to have multiple Controller Templates that implement a specific type of interface
such as IControllerTemplate. You should use the most specific interface type possible such as IDualAnalogGamepadTemplate instead,
which would be guaranteed to only apply to a single Controller Template.
|
| ImplementsTemplate(Guid) |
Determines if the Controller implements a Controller Template by type GUID.
|
| ImplementsTemplate(Type) |
Determines if the Controller implements a Controller Template by type.
|
| ImplementsTemplateT |
Determines if the Controller implements a Controller Template by type.
|
| PollForAllButtons | |
| PollForAllButtonsDown | |
| PollForAllElements | |
| PollForAllElementsDown | |
| PollForFirstButton | |
| PollForFirstButtonDown | |
| PollForFirstElement | |
| PollForFirstElementDown |
Fields| Name | Description | |
|---|---|---|
 | id |
Rewired unique id of this controller. This is not an index.
The id is unique among controllers of a specific controller type.
|
See Also