Class UIComponent

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

UnityEngine.EventSystems.UIBehaviour

UIComponent

UIWindow

Inherited Members

UnityEngine.EventSystems.UIBehaviour.OnEnable()

UnityEngine.EventSystems.UIBehaviour.Start()

UnityEngine.EventSystems.UIBehaviour.OnDisable()

UnityEngine.EventSystems.UIBehaviour.OnDestroy()

UnityEngine.EventSystems.UIBehaviour.IsActive()

UnityEngine.EventSystems.UIBehaviour.OnValidate()

UnityEngine.EventSystems.UIBehaviour.Reset()

UnityEngine.EventSystems.UIBehaviour.OnRectTransformDimensionsChange()

UnityEngine.EventSystems.UIBehaviour.OnBeforeTransformParentChanged()

UnityEngine.EventSystems.UIBehaviour.OnTransformParentChanged()

UnityEngine.EventSystems.UIBehaviour.OnDidApplyAnimationProperties()

UnityEngine.EventSystems.UIBehaviour.OnCanvasGroupChanged()

UnityEngine.EventSystems.UIBehaviour.OnCanvasHierarchyChanged()

UnityEngine.EventSystems.UIBehaviour.IsDestroyed()

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

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

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

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

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

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

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

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NoXP.Shared.UI

Assembly: NoXP.RuntimeComponents.dll

Syntax

public abstract class UIComponent : UIBehaviour

Fields

_isInitialized

Declaration

protected bool _isInitialized

Field Value

Type	Description
System.Boolean

_maskedModules

Declaration

protected int _maskedModules

Field Value

Type	Description
System.Int32

Properties

AnchoredPosition

Declaration

public Vector2 AnchoredPosition { get; set; }

Property Value

Type	Description
UnityEngine.Vector2

Content

Declaration

public UIComponent.ContentModule Content { get; }

Property Value

Type	Description
UIComponent.ContentModule

Pivot

Declaration

public Vector2 Pivot { get; set; }

Property Value

Type	Description
UnityEngine.Vector2

RectTransform

Declaration

public RectTransform RectTransform { get; }

Property Value

Type	Description
UnityEngine.RectTransform

Methods

Awake()

Declaration

protected override void Awake()

Overrides

UnityEngine.EventSystems.UIBehaviour.Awake()

Close()

Closes (deactivates) the UIComponent's gameObject and invokes the Closed event.

Declaration

public virtual void Close()

HasFlag(Int32, Int32)

Declaration

public static bool HasFlag(int value, int flags)

Parameters

Type	Name	Description
System.Int32	value
System.Int32	flags

Returns

Type	Description
System.Boolean

Init()

Declaration

protected virtual void Init()

Maximize()

Declaration

public virtual void Maximize()

Minimize()

Declaration

public virtual void Minimize()

OnClosed()

Declaration

protected virtual void OnClosed()

OnOpened()

Declaration

protected virtual void OnOpened()

Open()

Opens (activates) the UIComponent's gameObject and invokes the Opened event.

Declaration

public virtual void Open()

RefreshDisplayedModules()

Declaration

protected virtual void RefreshDisplayedModules()

RestoreState()

Declaration

public virtual void RestoreState()

SetActiveModules(Int32)

Declaration

public virtual void SetActiveModules(int activeModules)

Parameters

Type	Name	Description
System.Int32	activeModules

SetDisplayedModules(Int32)

Declaration

public virtual void SetDisplayedModules(int displayedModules)

Parameters

Type	Name	Description
System.Int32	displayedModules

SetPivot(Vector2, Boolean)

Declaration

public void SetPivot(Vector2 pivot, bool stayInPlace = true)

Parameters

Type	Name	Description
UnityEngine.Vector2	pivot
System.Boolean	stayInPlace

Toggle()

Toggles the UIComponent's gameObject active state and invokes the Closed or Closed event accordingly.

Declaration

public virtual void Toggle()

Events

Closed

Declaration

public event Action Closed

Event Type

Type	Description
System.Action

Opened

Declaration

public event Action Opened

Event Type

Type	Description
System.Action