Re |
Provides access to all controller-related members.
Inheritance HierarchyNamespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public sealed class ControllerHelper : CodeHelper
The ReInputControllerHelper type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | controllerCount | The number of controllers of all types currently connected. |
| Controllers | Gets a collection of connected controllers of all types. |
| customControllerCount | The number of custom controllers |
| CustomControllers | Get a collection of connected custom controllers. |
| joystickCount | The number of joysticks currently connected. |
| Joysticks | Get a collection of connected joysticks. |
| Keyboard | Gets the primary Keyboard controller. |
| keyboardEnabled |
Enabled or disables keyboard input processing. Disabling keyboard input can improve performance on mobile devices.
Also useful for joystick games on Android where certain joystick buttons return keyboard keycodes. Disabling keyboard input on Android will
still allow certain keyboard keys to return values if triggered by a button press on a joystick, but no keyboard maps will ever be processed.
Obsolete |
| Mouse | Gets the primary Mouse controller. |
Methods| Name | Description | |
|---|---|---|
 | AddLastActiveControllerChangedDelegate(ActiveControllerChangedDelegate) | Add a delegate to receive a callback every time the last active controller changes. |
| AddLastActiveControllerChangedDelegate(ActiveControllerChangedDelegate, ControllerType) | Add a delegate to receive a callback every time the last active controller of a specific type changes. |
| AutoAssignJoystick | Auto-assigns a Joystick to a Player based on the joystick auto-assignment settings in the Rewired Input Manager. If the Joystick is already assigned to a Player, the Joystick will not be re-assigned. |
| AutoAssignJoysticks | Auto-assigns all unassigned Joysticks to Players based on the joystick auto-assignment settings in the Rewired Input Manager. |
| ClearLastActiveControllerChangedDelegates | Remove all delegates to no longer receive any callbacks when the last active controller changes. |
| CreateCustomController(Int32) | Create a new CustomController object from a source definition in the Rewired Input Manager. |
| CreateCustomController(Int32, String) | Create a new CustomController object from a source definition in the Rewired Input Manager. |
| CustomControllersWithSourceId | Enumerates all CustomControllers with a matching source id. |
| CustomControllersWithTag | Enumerates all CustomControllers with a matching tag. |
| DestroyCustomController | Destroys a CustomController. |
| GetAnyButton | Get the button held state of all buttons on all controllers. Returns TRUE if any button is held. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButton(ControllerType) | Get the button held state of all buttons on all controllers of a specified type. Returns TRUE if any button is held. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonChanged | Returns true if any button has changed state from the previous frame to the current. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonChanged(ControllerType) | Returns true if any button has changed state from the previous frame to the current. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonDown | Get the button just pressed state of all buttons on all controllers. This will only return TRUE only on the first frame a button is pressed. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonDown(ControllerType) | Get the button just pressed state of all buttons on all controllers of a specified type. This will only return TRUE only on the first frame a button is pressed. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonPrev | Get the previous button held state of all buttons on all controllers. Returns TRUE if any button was held in the previous frame. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonPrev(ControllerType) | Get the previous button held state of all buttons on all controllers of a specified type. Returns TRUE if any button was held in the previous frame. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonUp | Get the button just released state of all buttons on all controllers of a specified type. This will only return TRUE only on the first frame a button is released. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetAnyButtonUp(ControllerType) | Get the button just released state of all buttons on all controllers of a specified type. This will only return TRUE only on the first frame a button is released. This retrieves the value from the actual hardware buttons, not Actions as mapped by Controller Maps in Player. |
| GetController(ControllerIdentifier) | Gets a controller that matches a Controller Idnetifier. |
| GetController(ControllerType, Int32) | Gets a controller of a specific type with a specific id. |
| GetControllerT(Int32) | Gets a controller of type by id. |
| GetControllerCount | Gets the number of controllers that exist of a specific type. |
| GetControllerNames | Get an array of connected controller names. Allocates an array, so use sparingly to reduce garbage collection. |
| GetControllers | Get a collection of connected controllers. Allocates an array, so use sparingly to reduce garbage collection. |
| GetControllerTemplatesTInterface | Gets a list of all Controller Templates in connected Controllers that match the type. |
| GetCustomController | Gets a specific custom controller |
| GetCustomControllerNames | Get an array of connected custom controller names. Allocates an array, so use sparingly to reduce garbage collection. |
| GetCustomControllers | Get a collection of connected custom controllers. Allocates an array, so use sparingly to reduce garbage collection. |
| GetFirstCustomControllerWithSourceId | Finds the first CustomController that has a matching source id. |
| GetFirstCustomControllerWithTag | Finds the first CustomController that has a matching tag. |
| GetJoystick | Gets a specific joystick. |
| GetJoystickNames | Gets an array of connected joystick names. Allocates an array, so use sparingly to reduce garbage collection. |
| GetJoysticks | Gets a collection of connected joysticks. Allocates an array, so use sparingly to reduce garbage collection. |
| GetLastActiveController | Get the last controller that produced input. If there is no last active controller, the Keyboard will be returned. |
| GetLastActiveController(ControllerType) | Get the last controller that produced input. If there is no last active controller of the specified type, the return value will be null. |
| GetLastActiveControllerT | Get the last controller that produced input. If there is no last active controller of the specified type, the return value will be null. |
| GetLastActiveControllerType | Get the controller type of the last controllerthat produced input. If there is no last active controller, ControllerType.Keyboard is returned. |
| GetUnityJoystickIdFromAnyButtonOrAxisPress | Returns the 0 based id of the Unity joystick whose button or axis was pressed. -1 if no button or axis was pressed on any joystick. Use this to identify joysticks when using Unity's input system. This has no effect if Unity Input is not handling input on the current platform. |
| GetUnityJoystickIdFromAnyButtonPress | Returns the 0 based id of the Unity joystick whose button was pressed. -1 if no button was pressed on any joystick. Use this to identify joysticks when using Unity's input system. This has no effect if Unity Input is not handling input on the current platform. |
| IsControllerAssigned(ControllerType, Controller) | Is the specified controller assigned to any players? |
| IsControllerAssigned(ControllerType, Int32) | Is the specified controller assigned to any players? |
| IsControllerAssignedToPlayer | Is the specified controller assigned to the specified player? |
| IsCustomControllerAssigned(CustomController) | Is a specific Custom Controller assigned to any players? |
| IsCustomControllerAssigned(Int32) | Is a specific Custom Controller assigned to any players? |
| IsCustomControllerAssignedToPlayer | Is a specific Custom Controller assigned to a specific player? |
| IsJoystickAssigned(Int32) | Is a specific Joystick assigned to any players? |
| IsJoystickAssigned(Joystick) | Is a specific Joystick assigned to any players? |
| IsJoystickAssignedToPlayer | Is a specific Joystick assigned to a specific player? |
| RemoveControllerFromAllPlayers(Controller, Boolean) | De-assigns the specified controller from all players. |
| RemoveControllerFromAllPlayers(ControllerType, Int32, Boolean) | De-assigns the specified controller from all players. |
| RemoveCustomControllerFromAllPlayers(CustomController, Boolean) | De-assigns a specific Custom Controller from all Players |
| RemoveCustomControllerFromAllPlayers(Int32, Boolean) | De-assigns a specific Custom Controller from all Players |
| RemoveJoystickFromAllPlayers(Int32, Boolean) | De-assigns a specific Joystick from all Players |
| RemoveJoystickFromAllPlayers(Joystick, Boolean) | De-assigns a specific Joystick from all Players |
| RemoveLastActiveControllerChangedDelegate(ActiveControllerChangedDelegate) | Remove a delegate to no longer receive callbacks when the last active controller changes. |
| RemoveLastActiveControllerChangedDelegate(ActiveControllerChangedDelegate, ControllerType) | Remove a delegate to no longer receive callbacks when the last active controller of a specific type changes. |
| SetUnityJoystickId | Sets a Unity joystick as the input source of a Joystick. Use this to remap a joystick to its source when reconnected on platforms that use Unity Input. This has no effect if Unity Input is not handling input on the current platform. |
| SetUnityJoystickIdFromAnyButtonOrAxisPress | Sets a Unity joystick as the input source of a Joystick. The first Unity joystick that returns a button or axis press will be assigned to the Joystick. While no buttons or axes are pressed, this will return False. When a press is detected, it will return True and assign the joystick id. |
| SetUnityJoystickIdFromAnyButtonPress | Sets a Unity joystick as the input source of a Joystick. The first Unity joystick that returns a button press will be assigned to the Joystick. While no buttons are pressed, this will return False. When a button press is detected, it will return True and assign the joystick id. |
Fields| Name | Description | |
|---|---|---|
 | conflictChecking | Provides access to Controller Map conflict checking-related members. |
| polling | Provides access to controller element polling-related members. This should only be used for controller mapping or other non-gameplay-related code. The polling system is expensive and should not be used during gameplay. |
See Also