Click or drag to resize

Controller Class

The base class for all controllers.
Inheritance Hierarchy

Namespace:  Rewired
Assembly:  Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public abstract class Controller

The Controller type exposes the following members.

Properties
  NameDescription
Public propertybuttonCount
The Button count in the controller.
Public propertyButtonElementIdentifiers
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.
Public propertyButtons
List of Buttons in this controller.
Public propertydeviceInstanceGuid
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.
Public propertyelementCount
The Element count in the controller.
Public propertyElementIdentifiers
Gets a list of all element identifiers of all types.
Public propertyElements
List of all Elements in this controller.
Public propertyenabled
Is the controller enabled? Disabled controllers return no input.
Public propertyextension
Gets an object used to access controller and platform-specific controller functions.
Public propertyhardwareIdentifier
String of information from the controller used for identifying unknown controller maps for saving/loading.
Public propertyhardwareName
The name the controller hardware returns.
Public propertyhardwareTypeGuid
The Rewired GUID associated with this device. A GUID of all zeros is an Unknown Controller.
Public propertyidentifier
Gets identifying information about the Controller.
Public propertyisConnected
Is the controller connected?
Public propertymapTypeString
String representation of the controller map type. Can be used for saving/loading.
Public propertyname
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.
Public propertytag
The tag assigned to the controller. Can be used for find a controller by tag.
Public propertytemplateCount
The Template count in the controller.
Public propertyTemplates
The Controller Templates that the Controller implements.
Public propertytype
The type of this controller.
Top
Methods
  NameDescription
Public methodGetAnyButton
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.
Public methodGetAnyButtonChanged
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.
Public methodGetAnyButtonDown
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.
Public methodGetAnyButtonPrev
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.
Public methodGetAnyButtonUp
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.
Public methodGetButton
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.
Public methodGetButtonById
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.
Public methodGetButtonChanged
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.
Public methodGetButtonDoublePressDown(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.
Public methodGetButtonDoublePressDown(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.
Public methodGetButtonDoublePressDownById(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.
Public methodGetButtonDoublePressDownById(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.
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressHoldById(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.
Public methodGetButtonDoublePressHoldById(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.
Public methodGetButtonDown
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.
Public methodGetButtonDownById
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.
Public methodGetButtonIndexById
Gets the index of the Button with the specified element idenfitier id.
Public methodGetButtonLastTimePressed
Gets the last timestamp the button at index was active.
Public methodGetButtonLastTimePressedById
Gets the last timestamp the button with the element identifier id was active.
Public methodGetButtonLastTimeUnpressed
Gets the last timestamp the button at index was inactive.
Public methodGetButtonLastTimeUnpressedById
Gets the last timestamp the button with the element identifier id was inactive.
Public methodGetButtonPrev
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.
Public methodGetButtonPrevById
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.
Public methodGetButtonTimePressed
Gets the length of time the button at index has been active.
Public methodGetButtonTimePressedById
Gets the length of time the button with the element identifier id has been active.
Public methodGetButtonTimeUnpressed
Gets the length of time the button at index has been inactive.
Public methodGetButtonTimeUnpressedById
Gets the length of time the button with the element identifier id has been inactive.
Public methodGetButtonUp
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.
Public methodGetButtonUpById
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.
Public methodGetElementById
Gets the Element with the specified element identifier id.
Public methodGetElementIdentifierById
Gets a Controller Element Identifier by id.
Public methodGetExtensionT
Gets an object used to access controller and platform-specific controller functions.
Public methodGetLastTimeActive
Gets the last timestamp any button was active. NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Public methodGetLastTimeActive(Boolean)
Gets the last timestamp any button was active. NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Public methodGetLastTimeAnyButtonChanged
Gets the last timestamp any button's state changed. NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Public methodGetLastTimeAnyButtonPressed
Gets the last timestamp any button was active. NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Public methodGetLastTimeAnyElementChanged
Gets the last timestamp any element changed state. NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Public methodGetLastTimeAnyElementChanged(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
Public methodGetTemplate(Guid)
Gets a Controller Template by type GUID.
Public methodGetTemplate(Type)
Gets a Controller Template by type.
Public methodGetTemplateT
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.
Public methodImplementsTemplate(Guid)
Determines if the Controller implements a Controller Template by type GUID.
Public methodImplementsTemplate(Type)
Determines if the Controller implements a Controller Template by type.
Public methodImplementsTemplateT
Determines if the Controller implements a Controller Template by type.
Public methodPollForAllButtons
Public methodPollForAllButtonsDown
Public methodPollForAllElements
Public methodPollForAllElementsDown
Public methodPollForFirstButton
Public methodPollForFirstButtonDown
Public methodPollForFirstElement
Public methodPollForFirstElementDown
Top
Fields
  NameDescription
Public fieldid
Rewired unique id of this controller. This is not an index. The id is unique among controllers of a specific controller type.
Top
See Also