My Project
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Properties | List of all members
Rewired.Integration.UnityUI.RewiredStandaloneInputModule Class Reference
Inheritance diagram for Rewired.Integration.UnityUI.RewiredStandaloneInputModule:
Rewired.Integration.UnityUI.RewiredPointerInputModule

Classes

class  PlayerSetting
 

Public Member Functions

override void UpdateModule ()
 
override bool IsModuleSupported ()
 
override bool ShouldActivateModule ()
 
override void ActivateModule ()
 
override void DeactivateModule ()
 
override void Process ()
 
- Public Member Functions inherited from Rewired.Integration.UnityUI.RewiredPointerInputModule
IMouseInputSource GetMouseInputSource (int playerId, int mouseIndex)
 Gets or sets the input source used for mouse input.
 
void RemoveMouseInputSource (IMouseInputSource source)
 Removes the mouse input source.
 
void AddMouseInputSource (IMouseInputSource source)
 Adds the mouse input source.
 
int GetMouseInputSourceCount (int playerId)
 Returns the number of possible pointers. Does not count the number actually assigned.
 
ITouchInputSource GetTouchInputSource (int playerId, int sourceIndex)
 Gets or sets the input source used for touch input.
 
void RemoveTouchInputSource (ITouchInputSource source)
 Removes the touch input source.
 
void AddTouchInputSource (ITouchInputSource source)
 Adds the touch input source.
 
int GetTouchInputSourceCount (int playerId)
 Returns the number of possible pointers. Does not count the number actually assigned.
 
override bool IsPointerOverGameObject (int pointerTypeId)
 
override string ToString ()
 

Protected Member Functions

override void Awake ()
 
override void OnDestroy ()
 
override bool IsDefaultPlayer (int playerId)
 
- Protected Member Functions inherited from Rewired.Integration.UnityUI.RewiredPointerInputModule
bool IsDefaultMouse (IMouseInputSource mouse)
 
void ClearMouseInputSources ()
 
abstract bool IsDefaultPlayer (int playerId)
 
bool GetPointerData (int playerId, int pointerIndex, int pointerTypeId, out PlayerPointerEventData data, bool create, PointerEventType pointerEventType)
 
void RemovePointerData (PlayerPointerEventData data)
 
PlayerPointerEventData GetTouchPointerEventData (int playerId, int touchDeviceIndex, Touch input, out bool pressed, out bool released)
 
virtual MouseState GetMousePointerEventData (int playerId, int mouseIndex)
 
PlayerPointerEventData GetLastPointerEventData (int playerId, int pointerIndex, int pointerTypeId, bool ignorePointerTypeId, PointerEventType pointerEventType)
 
virtual void ProcessMove (PlayerPointerEventData pointerEvent)
 
virtual void ProcessDrag (PlayerPointerEventData pointerEvent)
 
void ClearSelection ()
 
void DeselectIfSelectionChanged (GameObject currentOverGo, BaseEventData pointerEvent)
 
void CopyFromTo (PointerEventData @from, PointerEventData @to)
 
PointerEventData.FramePressState StateForMouseButton (int playerId, int mouseIndex, int buttonId)
 

Properties

InputManager_Base RewiredInputManager [get, set]
 (Optional) Link the Rewired Input Manager here for easier access to Player ids, etc.
 
bool UseAllRewiredGamePlayers [get, set]
 Allow all Rewired game Players to control the UI. This does not include the System Player. If enabled, this setting overrides individual Player Ids set in Rewired Player Ids.
 
bool UseRewiredSystemPlayer [get, set]
 Allow the Rewired System Player to control the UI.
 
int[] RewiredPlayerIds [get, set]
 A list of Player Ids that are allowed to control the UI. If Use All Rewired Game Players = True, this list will be ignored. Returns a clone of the array.
 
bool UsePlayingPlayersOnly [get, set]
 Allow only Players with Player.isPlaying = true to control the UI.
 
List< Rewired.Components.PlayerMouse > PlayerMice [get, set]
 Player Mice allowed to interact with the UI. Each Player that owns a Player Mouse must also be allowed to control the UI or the Player Mouse will not function.
 
bool MoveOneElementPerAxisPress [get, set]
 Makes an axis press always move only one UI selection. Enable if you do not want to allow scrolling through UI elements by holding an axis direction.
 
bool allowMouseInput [get, set]
 Allows the mouse to be used to select elements.
 
bool allowMouseInputIfTouchSupported [get, set]
 Allows the mouse to be used to select elements if the device also supports touch control.
 
bool allowTouchInput [get, set]
 Allows touch input to be used to select elements.
 
bool deselectIfBackgroundClicked [get, set]
 Deselects the current selection on mouse/touch click when the pointer is not over a selectable object.
 
bool SetActionsById [get, set]
 If enabled, Action Ids will be used to set the Actions. If disabled, string names will be used to set the Actions.
 
int HorizontalActionId [get, set]
 Name of the horizontal axis for movement (if axis events are used).
 
int VerticalActionId [get, set]
 Name of the vertical axis for movement (if axis events are used).
 
int SubmitActionId [get, set]
 Name of the action used to submit.
 
int CancelActionId [get, set]
 Name of the action used to cancel.
 
override bool isMouseSupported [get]
 
bool allowActivationOnMobileDevice [get, set]
 Allows the module to control UI input on mobile devices..
 
bool forceModuleActive [get, set]
 Forces the module to always be active.
 
float inputActionsPerSecond [get, set]
 
float repeatDelay [get, set]
 Delay in seconds before vertical/horizontal movement starts repeating continouously when a movement direction is held.
 
string horizontalAxis [get, set]
 Name of the horizontal axis for movement (if axis events are used).
 
string verticalAxis [get, set]
 Name of the vertical axis for movement (if axis events are used).
 
string submitButton [get, set]
 Name of the action used to submit.
 
string cancelButton [get, set]
 Name of the action used to cancel.
 
- Properties inherited from Rewired.Integration.UnityUI.RewiredPointerInputModule
ITouchInputSource defaultTouchInputSource [get]
 
virtual bool isMouseSupported [get]
 

Additional Inherited Members

- Static Public Attributes inherited from Rewired.Integration.UnityUI.RewiredPointerInputModule
const int kMouseLeftId = -1
 
const int kMouseRightId = -2
 
const int kMouseMiddleId = -3
 
const int kFakeTouchesId = -4
 

Member Function Documentation

◆ IsDefaultPlayer()

override bool Rewired.Integration.UnityUI.RewiredStandaloneInputModule.IsDefaultPlayer ( int  playerId)
inlineprotectedvirtual

Property Documentation

◆ inputActionsPerSecond

float Rewired.Integration.UnityUI.RewiredStandaloneInputModule.inputActionsPerSecond
getset

Number of selection changes allowed per second when a movement button/axis is held in a direction.


The documentation for this class was generated from the following file: