Class ViewControllerBase

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

ViewControllerBase

ViewController

Implements

IViewController

Inherited Members

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: MacacaGames.ViewSystem

Assembly: Macaca.ViewSystem.dll

Syntax

public abstract class ViewControllerBase : MonoBehaviour, IViewController

Fields

| Improve this Doc View Source

_incance

Declaration

protected static ViewControllerBase _incance

Field Value

Type	Description
ViewControllerBase

| Improve this Doc View Source

ChangePageToCoroutine

Declaration

protected Coroutine ChangePageToCoroutine

Field Value

Type	Description
UnityEngine.Coroutine

| Improve this Doc View Source

currentLiveElements

Declaration

[SerializeField]
protected List<ViewElement> currentLiveElements

Field Value

Type	Description
System.Collections.Generic.List<ViewElement>

| Improve this Doc View Source

currentViewPage

Declaration

[HideInInspector]
public ViewPage currentViewPage

Field Value

Type	Description
ViewPage

| Improve this Doc View Source

currentViewState

Declaration

[HideInInspector]
public ViewState currentViewState

Field Value

Type	Description
ViewState

| Improve this Doc View Source

lastViewPage

Declaration

[HideInInspector]
public ViewPage lastViewPage

Field Value

Type	Description
ViewPage

| Improve this Doc View Source

lastViewState

Declaration

[HideInInspector]
public ViewState lastViewState

Field Value

Type	Description
ViewState

| Improve this Doc View Source

minimumTimeInterval

Declaration

protected static float minimumTimeInterval

Field Value

Type	Description
System.Single

| Improve this Doc View Source

nextViewPage

Declaration

[HideInInspector]
public ViewPage nextViewPage

Field Value

Type	Description
ViewPage

| Improve this Doc View Source

nextViewState

Declaration

[HideInInspector]
public ViewState nextViewState

Field Value

Type	Description
ViewState

| Improve this Doc View Source

overlayPageStatusDict

The current active Overlay Dictionary which has no ViewState.

Declaration

[SerializeField]
protected Dictionary<string, ViewSystemUtilitys.OverlayPageStatus> overlayPageStatusDict

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, ViewSystemUtilitys.OverlayPageStatus>

| Improve this Doc View Source

viewPages

Declaration

public List<ViewPage> viewPages

Field Value

Type	Description
System.Collections.Generic.List<ViewPage>

| Improve this Doc View Source

viewStates

Declaration

public List<ViewState> viewStates

Field Value

Type	Description
System.Collections.Generic.List<ViewState>

| Improve this Doc View Source

viewStatesNames

Declaration

protected static IEnumerable<string> viewStatesNames

Field Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

Properties

| Improve this Doc View Source

IsOverlayTransition

Declaration

public bool IsOverlayTransition { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsPageTransition

Declaration

public bool IsPageTransition { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

platform

Declaration

public ViewPageItem.PlatformOption platform { get; }

Property Value

Type	Description
ViewPageItem.PlatformOption

Methods

| Improve this Doc View Source

Awake()

Declaration

protected virtual void Awake()

| Improve this Doc View Source

ChangePage(String, Action, Action, Action, Boolean, Boolean)

Declaration

public Coroutine ChangePage(string targetViewPageName, Action OnStart = null, Action OnChanged = null, Action OnComplete = null, bool AutoWaitPreviousPageFinish = false, bool ignoreTimeScale = false)

Parameters

Type	Name	Description
System.String	targetViewPageName
System.Action	OnStart
System.Action	OnChanged
System.Action	OnComplete
System.Boolean	AutoWaitPreviousPageFinish
System.Boolean	ignoreTimeScale

Returns

Type	Description
UnityEngine.Coroutine

| Improve this Doc View Source

ChangePageBase(String, Action, Action, Action, Boolean)

Declaration

public virtual IEnumerator ChangePageBase(string viewPageName, Action OnStart, Action OnCheaged, Action OnComplete, bool ignoreTimeScale)

Parameters

Type	Name	Description
System.String	viewPageName
System.Action	OnStart
System.Action	OnCheaged
System.Action	OnComplete
System.Boolean	ignoreTimeScale

Returns

Type	Description
System.Collections.IEnumerator

| Improve this Doc View Source

CheckTimeProtect()

Declaration

protected bool CheckTimeProtect()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

FullPageChanger()

Declaration

public static FullPageChanger FullPageChanger()

Returns

Type	Description
FullPageChanger

| Improve this Doc View Source

GetAllViewPageItemInViewPage(ViewPage)

Declaration

protected IEnumerable<ViewPageItem> GetAllViewPageItemInViewPage(ViewPage vp)

Parameters

Type	Name	Description
ViewPage	vp

Returns

Type	Description
System.Collections.Generic.IEnumerable<ViewPageItem>

| Improve this Doc View Source

GetAllViewPageItemInViewState(ViewState)

Declaration

protected IEnumerable<ViewPageItem> GetAllViewPageItemInViewState(ViewState vs)

Parameters

Type	Name	Description
ViewState	vs

Returns

Type	Description
System.Collections.Generic.IEnumerable<ViewPageItem>

| Improve this Doc View Source

GetCanvas()

Declaration

public virtual Canvas GetCanvas()

Returns

Type	Description
UnityEngine.Canvas

| Improve this Doc View Source

GetCurrentOverpageNames()

Declaration

public virtual IEnumerable<string> GetCurrentOverpageNames()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

| Improve this Doc View Source

GetOverlayStateKey(ViewPage)

Declaration

protected string GetOverlayStateKey(ViewPage vp)

Parameters

Type	Name	Description
ViewPage	vp

Returns

Type	Description
System.String

| Improve this Doc View Source

HasOverlayPageLive()

Declaration

public virtual bool HasOverlayPageLive()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

InvokeOnOverlayPageLeave(Object, ViewControllerBase.ViewPageEventArgs)

Declaration

protected virtual void InvokeOnOverlayPageLeave(object obj, ViewControllerBase.ViewPageEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewPageEventArgs	args

| Improve this Doc View Source

InvokeOnOverlayPageShow(Object, ViewControllerBase.ViewPageEventArgs)

Declaration

protected virtual void InvokeOnOverlayPageShow(object obj, ViewControllerBase.ViewPageEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewPageEventArgs	args

| Improve this Doc View Source

InvokeOnViewPageChange(Object, ViewControllerBase.ViewPageEventArgs)

Declaration

protected virtual void InvokeOnViewPageChange(object obj, ViewControllerBase.ViewPageEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewPageEventArgs	args

| Improve this Doc View Source

InvokeOnViewPageChangeEnd(Object, ViewControllerBase.ViewPageEventArgs)

Declaration

protected virtual void InvokeOnViewPageChangeEnd(object obj, ViewControllerBase.ViewPageEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewPageEventArgs	args

| Improve this Doc View Source

InvokeOnViewPageChangeStart(Object, ViewControllerBase.ViewPageTrisitionEventArgs)

Declaration

protected virtual void InvokeOnViewPageChangeStart(object obj, ViewControllerBase.ViewPageTrisitionEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewPageTrisitionEventArgs	args

| Improve this Doc View Source

InvokeOnViewStateChange(Object, ViewControllerBase.ViewStateEventArgs)

Declaration

protected virtual void InvokeOnViewStateChange(object obj, ViewControllerBase.ViewStateEventArgs args)

Parameters

Type	Name	Description
System.Object	obj
ViewControllerBase.ViewStateEventArgs	args

| Improve this Doc View Source

IsOverPageLive(String)

Declaration

public virtual bool IsOverPageLive(string viewPageName)

Parameters

Type	Name	Description
System.String	viewPageName

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsViewPageExsit(String)

Declaration

public abstract bool IsViewPageExsit(string viewPageName)

Parameters

Type	Name	Description
System.String	viewPageName

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

LeaveOverlayViewPage(String, Single, Action, Boolean, Boolean, Boolean)

Declaration

public Coroutine LeaveOverlayViewPage(string viewPageName, float tweenTimeIfNeed = 0.4F, Action OnComplete = null, bool ignoreTransition = false, bool ignoreTimeScale = false, bool waitForShowFinish = false)

Parameters

Type	Name	Description
System.String	viewPageName
System.Single	tweenTimeIfNeed
System.Action	OnComplete
System.Boolean	ignoreTransition
System.Boolean	ignoreTimeScale
System.Boolean	waitForShowFinish

Returns

Type	Description
UnityEngine.Coroutine

| Improve this Doc View Source

LeaveOverlayViewPageBase(ViewSystemUtilitys.OverlayPageStatus, Single, Action, Boolean, Boolean, Boolean)

Declaration

public virtual IEnumerator LeaveOverlayViewPageBase(ViewSystemUtilitys.OverlayPageStatus overlayPageState, float tweenTimeIfNeed, Action OnComplete, bool ignoreTransition = false, bool ignoreTimeScale = false, bool waitForShowFinish = false)

Parameters

Type	Name	Description
ViewSystemUtilitys.OverlayPageStatus	overlayPageState
System.Single	tweenTimeIfNeed
System.Action	OnComplete
System.Boolean	ignoreTransition
System.Boolean	ignoreTimeScale
System.Boolean	waitForShowFinish

Returns

Type	Description
System.Collections.IEnumerator

| Improve this Doc View Source

OverlayPageChanger()

Declaration

public static OverlayPageChanger OverlayPageChanger()

Returns

Type	Description
OverlayPageChanger

| Improve this Doc View Source

RecoveryChanger(PageChanger)

Declaration

public void RecoveryChanger(PageChanger pageChanger)

Parameters

Type	Name	Description
PageChanger	pageChanger

| Improve this Doc View Source

ShowOverlayViewPage(String, Boolean, Action, Action, Action, Boolean)

Declaration

public Coroutine ShowOverlayViewPage(string viewPageName, bool RePlayOnShowWhileSamePage = false, Action OnStart = null, Action OnChanged = null, Action OnComplete = null, bool ignoreTimeScale = false)

Parameters

Type	Name	Description
System.String	viewPageName
System.Boolean	RePlayOnShowWhileSamePage
System.Action	OnStart
System.Action	OnChanged
System.Action	OnComplete
System.Boolean	ignoreTimeScale

Returns

Type	Description
UnityEngine.Coroutine

| Improve this Doc View Source

ShowOverlayViewPageBase(ViewPage, Boolean, Action, Action, Action, Boolean)

Declaration

public virtual IEnumerator ShowOverlayViewPageBase(ViewPage vp, bool RePlayOnShowWhileSamePage, Action OnStart, Action OnChanged, Action OnComplete, bool ignoreTimeScale = false)

Parameters

Type	Name	Description
ViewPage	vp
System.Boolean	RePlayOnShowWhileSamePage
System.Action	OnStart
System.Action	OnChanged
System.Action	OnComplete
System.Boolean	ignoreTimeScale

Returns

Type	Description
System.Collections.IEnumerator

| Improve this Doc View Source

Start()

Declaration

protected virtual void Start()

| Improve this Doc View Source

StartMicroCoroutine(IEnumerator)

Declaration

public MicroCoroutine.Coroutine StartMicroCoroutine(IEnumerator routine)

Parameters

Type	Name	Description
System.Collections.IEnumerator	routine

Returns

Type	Description
MicroCoroutine.Coroutine

| Improve this Doc View Source

StopMicroCoroutine(MicroCoroutine.Coroutine)

Declaration

public void StopMicroCoroutine(MicroCoroutine.Coroutine coroutine)

Parameters

Type	Name	Description
MicroCoroutine.Coroutine	coroutine

| Improve this Doc View Source

TryLeaveAllOverlayPage()

Declaration

public virtual void TryLeaveAllOverlayPage()

| Improve this Doc View Source

WaitPrevious(String, Action, Action, Action, Boolean)

Declaration

public IEnumerator WaitPrevious(string viewPageName, Action OnStart, Action OnChanged, Action OnComplete, bool ignoreTimeScale)

Parameters

Type	Name	Description
System.String	viewPageName
System.Action	OnStart
System.Action	OnChanged
System.Action	OnComplete
System.Boolean	ignoreTimeScale

Returns

Type	Description
System.Collections.IEnumerator

Events

| Improve this Doc View Source

OnOverlayPageLeave

OnOverlayPageLeave Calls on an overlay page is leave.(the transition may still working)

Declaration

public event EventHandler<ViewControllerBase.ViewPageEventArgs> OnOverlayPageLeave

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewPageEventArgs>

| Improve this Doc View Source

OnOverlayPageShow

OnOverlayPageShow Calls on an overlay page is show.(the transition may still working)

Declaration

public event EventHandler<ViewControllerBase.ViewPageEventArgs> OnOverlayPageShow

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewPageEventArgs>

| Improve this Doc View Source

OnViewPageChange

OnViewPageChange Calls on last page has leave finished, next page is ready to show.

Declaration

public event EventHandler<ViewControllerBase.ViewPageEventArgs> OnViewPageChange

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewPageEventArgs>

| Improve this Doc View Source

OnViewPageChangeEnd

OnViewPageChangeEnd Calls on page is changed finish, all animation include in OnShow or OnLeave is finished. (Note. the sometimes the Event fire early due to the animation time is longer than "Change Page Max Waiting" time)

Declaration

public event EventHandler<ViewControllerBase.ViewPageEventArgs> OnViewPageChangeEnd

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewPageEventArgs>

| Improve this Doc View Source

OnViewPageChangeStart

OnViewPageChangeStart Calls on page is ready to change with no error(eg. no page fonud etc.), and in this moment last page is still in view.

Declaration

public event EventHandler<ViewControllerBase.ViewPageTrisitionEventArgs> OnViewPageChangeStart

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewPageTrisitionEventArgs>

| Improve this Doc View Source

OnViewStateChange

OnViewStateChange Calls on the ViewPage is changed and has different ViewState.

Declaration

public event EventHandler<ViewControllerBase.ViewStateEventArgs> OnViewStateChange

Event Type

Type	Description
System.EventHandler<ViewControllerBase.ViewStateEventArgs>

Implements

IViewController