InputMapper Class |
A class that simplifies the process of remapping controls.
Handles listening for controller input, conflict checking, and creating Action-element assignments.
Inheritance HierarchySystemObject
RewiredInputMapper
RewiredInputMapper
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public sealed class InputMapper
The InputMapper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | InputMapper |
Creates a new InputMapper.
|
Properties| Name | Description | |
|---|---|---|
  | Default | |
| mappingContext |
Gets the mapping Context object. This allows you to see the current mapping
context being used while the mapper is listening. You cannot change any settings
in the mapping context. To change mapping contexts, restart input mapper with a
new context. If the mapper is idle, this value will be null.
|
| options |
Gets the Options object. Configure settings here.
If set to null, the default Options will be used instead.
Changing this or any values in Options while the mapper is
listening will have no effect until the mapper is started again.
|
| status |
The current status of the mapper.
|
| timeRemaining |
The time remaining before the mapper times out. Always returns 0 if no timeout was set or if the timer was stopped.
|
Methods| Name | Description | |
|---|---|---|
| Clear |
Stops the mapper and clears all event listeners, callbacks, and Options.
|
| RemoveAllEventListeners |
Removes all event listeners from all events.
|
| RemoveEventListeners |
Removes the event listener(s) from all events.
You can pass the object that contains the target delegates
to unsubscribe all delegates in that object from all events.
For example, if your class MyClass subscribes to several events,
you can pass the MyClass object into this method to remove all of
its listeners. Example: mapper.RemoveEventListeners(this);
|
| Start |
Starts listening for input.
|
| Stop |
Stops listening for input.
|
Events| Name | Description | |
|---|---|---|
 | CanceledEvent |
Event that is triggered when listening is canceled.
|
| ConflictFoundEvent |
Event that is triggered when an assignment conflict is found.
|
| ErrorEvent |
Event that is triggered an error occurs.
|
| InputMappedEvent |
Event that is triggered when an input assignment is made.
|
| StartedEvent |
Event that is triggered when listening is started.
|
| StoppedEvent |
Event that is triggered when listening stops.
|
| TimedOutEvent |
Event that is triggered when listening times out.
|
See Also