Rewired Namespace

Maps an Action to a Controller element.

A PropertyAttribute for an InputAction id. Use on a serialized int field to allow selecting of Rewired Actions from a popup in the Unity inspector. Usage: [ActionIdProperty(typeof(MyType)] Type should be a class that contains public const int fields, each of which corresponds to a Rewired Input Action id.

Holds calibration information for a controller axis.

Maps calibration data to a controller's axes.

Save data for a Calibration Map.

The base class for all controllers.

An Axis controller element.

Axis 2D is a combination of values from two individual Axes. This is primarily used for analog sticks. A radial deadzone is applied to the combined values. The deazone is the larger of the two deadzones set in the individual axes. Axis 2D cannot be mapped with an ActionElementMap. Instead, the component Axes are each mapped individually. When two Axes are combined into an Axis2D, the values of the individual Axes are changed to reflect the radial deadzone applied by the parent Axis2D.

A Button controller element.

Base class for compound elements. Compound elements are a combination of existing elements such as 2 axes making up an Axis 2D. Compound elements have no value in and of themselves, but combine values from their member elements to produce a result. Compound elements cannot be mapped with an ActionElementMap. Instead, the component axes are each mapped individually.

A directional pad is a compound element made up of 4 individual buttons.

The base class for all controller elements.

A class that can be used as a base class to allow for special controller or platform-specific functions in a controller.

A hat is a compound element made up of 4 or 8 individual buttons. If this is a 4-way hat, only up, down, right, and left are supported. Corner presses will activate the two cardinal directions. If this is an 8-way hat, all 8 directions are supported. Corner presses will activate the corner buttons.

Event args returned by controller assignment and unassignment events in Players. Contains information about the controller that was changed.

Represents a single element on a controller. Used to identify physical elements on controllers by type and name.

The base class for all controller maps. Maps actions to specific controller elements.

Enforces persistent enabled states on Controller Maps in a Player based on user settings. This can be used to make specific Controller Maps be enabled or disabled in a Player, for example when changing game modes that require user input to change. These settings will persist and be inherited by new Controllers assigned to the Player. Enabled states will be sync'd when new Controllers are added, when Controller Maps are loaded, etc. When using ControllerMapEnabler, you should not manually set enabled states on Controller Maps that are managed by this class, but instead change all settings within this class.

Settings for persisting the enabled state of Controller Maps.

A set of Rules.

Manages loading and unloading of Controller Maps in a Player based on user settings to force the specified Layouts to be used. This can be used to make specific Controller Maps be loaded in a Player with specific Layouts, for example when changing from one Controller Layout to another. These settings will persist and be inherited by new Controllers assigned to the Player. This will enforce a single Layout per managed Map Category be loaded in the Player. This cannot manage mutliple simultaneous Layouts in the same Map Category being loaded in the Player. This does not manage enabled states of the Controller Maps. It only manages loading and unloading of Controller Maps.

Settings for persisting a Controller Map Layout.

A set of Rules.

Base class for controller map save data.

Maps actions to controller elements for a controller with axes.

Used for selecting Controllers based on the specified criteria. See static factory methods for construction.

Event args returned by controller connect and disconnect events. Contains information about the controller that was changed.

Base class for a Controller Template.

Maps an Action to a Controller Template Axis element.

Maps an Action to a Controller Template Button element.

Maps an Action to a Controller Template element.

Represents a single element on a controller template. Used to identify physical elements on controller templates by type and name.

Maps actions to specific Controller Template elements.

A controller with buttons and axes.

The contents of this class have been moved into Conroller. This class no longer serves any purpose and may be removed in the future.

A virtual controller with a user-defined input source.

Maps actions to controller elements for a custom controller.

Used to retrieve saveable custom controller map data.

Describes a pending element assignment.

Class representing a Flight Pedals Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface IFlightPedalsTemplate instead.

Class representing a Flight Yoke Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface IFlightYokeTemplate instead.

Class representing a Gamepad Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface IGamepadTemplate instead.

Class representing a HOTAS Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface IHOTASTemplate instead.

Represents a single action.

A category for organizing Actions.

Provides configuration options for an InputAction.

A category for organizing input-related data.

A layout for organizing input maps.

A category for organizing controller maps.

A class that simplifies the process of remapping controls. Handles listening for controller input, conflict checking, and creating Action-element assignments.

Data for a canceled event.

Data for a conflict event.

Provides information about an input mapping. This is used to define what is being mapped and how user input should be handled.

Data for an error event.

Base class for event data.

Data for an input mapped event.

Configuration options for the InputMapper.

Data for a started event.

Data for a stopped event.

Data for a timed out event.

A joystick with buttons and axes.

Save data for a Joystick Calibration Map.

Maps actions to controller elements for a joystick.

Used to retrieve saveable joystick map data.

A keyboard with keys.

Maps actions to controller elements for a keyboard.

Used to retrieve saveable keyboard map data.

A mouse with buttons and axes.

Maps actions to controller elements for a mouse.

Used to retrieve saveable mouse map data.

Represents a player to which controllers are assigned. Input should normally be managed through the Player class.

Provides access to all controller-related members in Player.

Provides access to all controller element assignment conflict checking related members.

Provides access to all mapping related members.

Provides access to all 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.

A controller that uses Player Actions as the input sources for controller elements.

An Axis that uses Player Actions as the value source.

Properties to use when creating a new Axis.

An element with 2 Axes.

A Button that uses Player Actions as the value source.

Properties to use when creating a new Button.

Base for elements with multiple source elements.

Definition for Player Controller.

Base class for elements.

Properties to use when creating a new Element.

Base class for elements that have an input source.

Class for creating Player Controller instances.

A Mouse Axis that uses Player Actions as the value source. Source value is automatically scaled to screen resolution.

Properties to use when creating a new Mouse Axis.

An element with 2 Mouse Axes.

Properties to use when creating a new MouseWheelAxis.

A PropertyAttribute for a Player id. Use on a serialized int field to allow selecting of Rewired Players from a popup in the Unity inspector. Usage: [PlayerIdProperty(typeof(MyType)] Type should be a class that contains public const int fields, each of which corresponds to a Rewired Player id.

A virtual mouse that can be used to drive a sprite or software mouse pointer. It uses a Rewired Player to move the pointer position and as the source for the buttons and axes.

Definition for a Player Mouse.

Class for creating Player Mouse instances.

Class representing a Racing Wheel Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface IRacingWheelTemplate instead.

The main class for accessing all input-related information.

Provides access to time-related data. This is mostly for accurate unscaled time comparisons for button and axis times.

Provides access to all controller-related members.

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.

Provides access to all glyph-related members.

Provides access to all localization-related members.

Provides access to all mapping-related data defined in the Rewired Editor. This data is read-only. Data created in the Rewired Editor cannot be changed at run time.

Provides access to all player-related members.

Provides access to time-related data. This is mostly for accurate unscaled time comparisons for button and axis times.

Provides access to touch-related members.

Class representing a 6 DoF Controller Template. This class contains constants. Do not use this class to interact with the Rewired API. Use the interface ISixDofControllerTemplate instead.

A struct for working with axis calibration data.

Describes a specific Controller Element on a Controller including a partial Axis.

Information to identify a Controller.

Contains polling information recieved from a controller element polling request. Use this to determine which controller element was activated for use in control remapping.

Describes a specific Controller Template Element on a Controller Template including a partial Axis.

A struct for making a controller element assignement.

A struct for performing a controller element assignment conflict check.

Information about a controller element assignment conflict.

Event data returned by an Input Action update event. Use this to get information about the input event.

Provides information about the current sources contributing to the value of an Input Action.

A struct used for retrieving all the saveable data in a Player.

Interface for a Controller element target.

Interface for a Controller Template.

Interface for a Controller Template Axis. An Axis has a floating-point value. An Axis consists of two poles, positive and negative.

Interface for a Controller Template Axis Source. This provides information about the source of the Controller Template Axis.

Interface for a Controller Template Button. A Button has an on/off value and optionally a pressure value.

Interface for a Controller Template Button Source. This provides information about the source of the Controller Template Button.

Interface for a Controller Template D-Pad. A D-Pad consists of 4 directional buttons and an optional press-in button.

Interface for a Controller Template Element.

Interface for a Controller Template Element Source. This provides information about the source of the Controller Template Element.

Interface for a Controller Template Hat. A Hat is an 8-directional switch. This is commonly used on flight sticks.

Interface for a Controller Template Stick. A Stick can have up to 3 axes: Horizontal, Vertical, and Rotation. This is used for flight sticks.

Interface for a Controller Template 6 DoF Stick.

Interface for a Controller Template Throttle. A Throttle has an axis and an optional button activated when the throttle is at its minimum value.

Interface for a Controller Template Thumb Stick. A Thumb Stick has 2 axes and an optional button. This is used for gamepad sticks.

Interface for a Controller Template Yoke. A Yoke has 2 axes: Rotation and Push/Pull. This is used for flight yokes.

Interface for a Flight Pedals Controller Template.

Interface for a Flight Yoke Controller Template.

Interface for a Gamepad Controller Template.

Interface for a HOTAS Controller Template.

Interface for a Racing Wheel Controller Template.

Interface for a 6 DoF Controller Controller Template.

Delegate for a current active controller change.

Delegate for a current active controller change in a Player.

The axis coordinate mode.

The range of an axis.

Calculation type for sensitivity on 2D axes.

Axis sensitivity calculation type.

The type of axis.

The type of a compound element in a controller.

The type of an element in a controller.

The Controller selector type.

Controller Template Element Source type.

Controller Template Element type.

The type of a controller.

Calculation type for 2D deadzones.

The type of an element assignment.

Input action events. When using event based input, this is used to specify when to send an event.

The expected element type of an action.

Actions to take when a conflict is found.

The status of the mapper.

A keyboard key code.

A keyboard modifier key type.

Keyboard modifier keys as flags.

An input element on the mouse.

The mode for the mouse's other axes apart from X and Y.

The delta calulation mode for the mouse's X and Y axes.

The mode for the mouse's X and Y axes.

The unit of the movement area.

A positive or negative value.

Unity update loop type.