Mouse Methods |
The Mouse type exposes the following members.
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
GetAxis |
Gets the current axis value.
(Inherited from ControllerWithAxes.) | |
GetAxis2D |
Gets the current 2D axis value.
(Inherited from ControllerWithAxes.) | |
GetAxis2DPrev |
Gets the 2D axis value from the previous frame.
(Inherited from ControllerWithAxes.) | |
GetAxis2DRaw |
Gets the current raw 2D axis value. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxis2DRawPrev |
Gets the raw 2D axis value from the previous frame.. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxisById |
Gets the current axis value.
(Inherited from ControllerWithAxes.) | |
GetAxisIndexById |
Gets the index of the Axis with the specified element idenfitier id.
(Inherited from ControllerWithAxes.) | |
GetAxisLastTimeActive | (Inherited from ControllerWithAxes.) | |
GetAxisLastTimeActiveById | (Inherited from ControllerWithAxes.) | |
GetAxisLastTimeInactive | (Inherited from ControllerWithAxes.) | |
GetAxisLastTimeInactiveById | (Inherited from ControllerWithAxes.) | |
GetAxisPrev |
Gets the axis value from the previous frame.
(Inherited from ControllerWithAxes.) | |
GetAxisPrevById |
Gets the axis value from the previous frame.
(Inherited from ControllerWithAxes.) | |
GetAxisRaw |
Gets the current raw axis value. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxisRawById |
Gets the current raw axis value. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxisRawLastTimeActive | (Inherited from ControllerWithAxes.) | |
GetAxisRawLastTimeActiveById | (Inherited from ControllerWithAxes.) | |
GetAxisRawLastTimeInactive | (Inherited from ControllerWithAxes.) | |
GetAxisRawLastTimeInactiveById | (Inherited from ControllerWithAxes.) | |
GetAxisRawPrev |
Gets the raw axis value from the previous frame.. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxisRawPrevById |
Gets the raw axis value from the previous frame.. Excludes calibration.
(Inherited from ControllerWithAxes.) | |
GetAxisRawTimeActive | (Inherited from ControllerWithAxes.) | |
GetAxisRawTimeActiveById | (Inherited from ControllerWithAxes.) | |
GetAxisRawTimeInactive | (Inherited from ControllerWithAxes.) | |
GetAxisRawTimeInactiveById | (Inherited from ControllerWithAxes.) | |
GetAxisTimeActive | (Inherited from ControllerWithAxes.) | |
GetAxisTimeActiveById | (Inherited from ControllerWithAxes.) | |
GetAxisTimeInactive | (Inherited from ControllerWithAxes.) | |
GetAxisTimeInactiveById | (Inherited from ControllerWithAxes.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
GetButtonIndexById |
Gets the index of the Button with the specified element idenfitier id.
(Inherited from Controller.) | |
GetButtonLastTimePressed |
Gets the last timestamp the button at index was active.
(Inherited from Controller.) | |
GetButtonLastTimePressedById |
Gets the last timestamp the button with the element identifier id was active.
(Inherited from Controller.) | |
GetButtonLastTimeUnpressed |
Gets the last timestamp the button at index was inactive.
(Inherited from Controller.) | |
GetButtonLastTimeUnpressedById |
Gets the last timestamp the button with the element identifier id was inactive.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
GetButtonTimePressed |
Gets the length of time the button at index has been active.
(Inherited from Controller.) | |
GetButtonTimePressedById |
Gets the length of time the button with the element identifier id has been active.
(Inherited from Controller.) | |
GetButtonTimeUnpressed |
Gets the length of time the button at index has been inactive.
(Inherited from Controller.) | |
GetButtonTimeUnpressedById |
Gets the length of time the button with the element identifier id has been inactive.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
GetCompoundElementById |
Gets the Compound Element with the specified element identifier id.
(Inherited from Controller.) | |
GetCompundElementById | Obsolete.
OBSOLETE: This method is deprecated. Use GetCompoundElementById(Int32) instead.
Gets the Compound Element with the specified element identifier id.
(Inherited from Controller.) | |
GetElementById |
Gets the Element with the specified element identifier id.
(Inherited from ControllerWithAxes.) | |
GetElementIdentifierById |
Gets a Controller Element Identifier by id.
(Inherited from Controller.) | |
GetExtensionT |
Gets an object used to access controller and platform-specific controller functions.
(Inherited from Controller.) | |
GetLastTimeActive |
Gets the last timestamp any axis or button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeActive(Boolean) |
Gets the last timestamp any axis or button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeAnyAxisActive |
Gets the last timestamp any axis was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeAnyAxisActive(Boolean) |
Gets the last timestamp any axis was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeAnyAxisChanged |
Gets the last timestamp any axis changed value.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeAnyAxisChanged(Boolean) |
Gets the last timestamp any axis changed value.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
GetLastTimeAnyButtonChanged |
Gets the last timestamp any button's state changed.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller.) | |
GetLastTimeAnyButtonPressed |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller.) | |
GetLastTimeAnyElementChanged |
Gets the last timestamp any element changed state.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from ControllerWithAxes.) | |
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 (Inherited from ControllerWithAxes.) | |
GetTemplate(Guid) |
Gets a Controller Template by type GUID.
(Inherited from Controller.) | |
GetTemplate(Type) |
Gets a Controller Template by type.
(Inherited from Controller.) | |
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.
(Inherited from Controller.) | |
ImplementsTemplate(Guid) |
Determines if the Controller implements a Controller Template by type GUID.
(Inherited from Controller.) | |
ImplementsTemplate(Type) |
Determines if the Controller implements a Controller Template by type.
(Inherited from Controller.) | |
ImplementsTemplateT |
Determines if the Controller implements a Controller Template by type.
(Inherited from Controller.) | |
ImportCalibrationMapFromJsonString |
Imports a Calibration Map from JSON.
(Inherited from ControllerWithAxes.) | |
ImportCalibrationMapFromXmlString |
Imports a Calibration Map from XML.
(Inherited from ControllerWithAxes.) | |
PollForAllAxes | (Inherited from ControllerWithAxes.) | |
PollForAllButtons | (Inherited from Controller.) | |
PollForAllButtonsDown | (Inherited from Controller.) | |
PollForAllElements | (Inherited from ControllerWithAxes.) | |
PollForAllElementsDown | (Inherited from ControllerWithAxes.) | |
PollForFirstAxis | (Inherited from ControllerWithAxes.) | |
PollForFirstButton | (Inherited from Controller.) | |
PollForFirstButtonDown | (Inherited from Controller.) | |
PollForFirstElement | (Inherited from ControllerWithAxes.) | |
PollForFirstElementDown | (Inherited from ControllerWithAxes.) |