Class BaseInput

Interface to the Input system used by the BaseInputModule. With this it is possible to bypass the Input system with your own but still use the same InputModule. For example this can be used to feed fake input into the UI or interface with a different input system.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UIBehaviour

BaseInput

Inherited Members

UIBehaviour.Awake()

UIBehaviour.OnEnable()

UIBehaviour.Start()

UIBehaviour.OnDisable()

UIBehaviour.OnDestroy()

UIBehaviour.IsActive()

UIBehaviour.OnValidate()

UIBehaviour.Reset()

UIBehaviour.OnRectTransformDimensionsChange()

UIBehaviour.OnBeforeTransformParentChanged()

UIBehaviour.OnTransformParentChanged()

UIBehaviour.OnDidApplyAnimationProperties()

UIBehaviour.OnCanvasGroupChanged()

UIBehaviour.OnCanvasHierarchyChanged()

UIBehaviour.IsDestroyed()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.EventSystems

Assembly: UnityEngine.UI.dll

Syntax

public class BaseInput : UIBehaviour

Properties

compositionCursorPos

Interface to Input.compositionCursorPos. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual Vector2 compositionCursorPos { get; set; }

Property Value

Type	Description
Vector2

compositionString

Interface to Input.compositionString. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual string compositionString { get; }

Property Value

Type	Description
string

imeCompositionMode

Interface to Input.imeCompositionMode. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual IMECompositionMode imeCompositionMode { get; set; }

Property Value

Type	Description
IMECompositionMode

mousePosition

Interface to Input.mousePosition. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual Vector2 mousePosition { get; }

Property Value

Type	Description
Vector2

mousePresent

Interface to Input.mousePresent. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool mousePresent { get; }

Property Value

Type	Description
bool

mouseScrollDelta

Interface to Input.mouseScrollDelta. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual Vector2 mouseScrollDelta { get; }

Property Value

Type	Description
Vector2

mouseScrollDeltaPerTick

The magnitude of mouseScrollDelta that corresponds to exactly one tick of the scroll wheel.

Declaration

public virtual float mouseScrollDeltaPerTick { get; }

Property Value

Type	Description
float

touchCount

Interface to Input.touchCount. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual int touchCount { get; }

Property Value

Type	Description
int

touchSupported

Interface to Input.touchSupported. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool touchSupported { get; }

Property Value

Type	Description
bool

Methods

GetAxisRaw(string)

Interface to Input.GetAxisRaw. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual float GetAxisRaw(string axisName)

Parameters

Type	Name	Description
string	axisName	Axis name to check

Returns

Type	Description
float

GetButtonDown(string)

Interface to Input.GetButtonDown. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool GetButtonDown(string buttonName)

Parameters

Type	Name	Description
string	buttonName	Button name to get

Returns

Type	Description
bool

GetMouseButton(int)

Interface to Input.GetMouseButton. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool GetMouseButton(int button)

Parameters

Type	Name	Description
int	button

Returns

Type	Description
bool

GetMouseButtonDown(int)

Interface to Input.GetMouseButtonDown. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool GetMouseButtonDown(int button)

Parameters

Type	Name	Description
int	button

Returns

Type	Description
bool

GetMouseButtonUp(int)

Interface to Input.GetMouseButtonUp. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual bool GetMouseButtonUp(int button)

Parameters

Type	Name	Description
int	button

Returns

Type	Description
bool

GetTouch(int)

Interface to Input.GetTouch. Can be overridden to provide custom input instead of using the Input class.

Declaration

public virtual Touch GetTouch(int index)

Parameters

Type	Name	Description
int	index	Touch index to get

Returns

Type	Description
Touch