MenuSystem

• Create new Page class and inherit from BasePage<T> or  Page<T>. BasePage class have its own default Show and Hide method without parameter. You can inherit from Page<T> if you want passing some data to the page by defining your own Show and Hide method.

Public class ExamplePage : BasePage<ExamplePage> { }

or

Public class ExamplePage : Page<ExamplePage> { 
    public void Show(float parameter1, int parameter2){   
        Open();
        //Write your code here
    }
    public void Hide(){         
        Close(); 
        //Write your code here    
    }
}

• Page Class can be accessed using PageManager instance TryGetPage or GetPage method. Both method will return the page as long as its added to the PageManager page list.

ExamplePage page;
page = PageManager.Instance.GetPage<ExamplePage>()
                          or
if(PageManager.Instance.TryGetPage<ExamplePage>(out var page)){ 
    page.Show()
}

• Instantiate Page prefab into the scene using PageManager instance CreatePageInstance method. it will return an exception if the Page prefab was not found in the page list.

ExamplePage page = CreatePageInstance<ExamplePage>()

• Create new class script and inherit from BasePageAnimation abstract class.
• Override the abstract method and write your own logic inside the method. Both unity action event need to invoked for the animation worked properly.

public class ExamplePageAnimation : BasePageAnimation{
    public override void PlayEntryAnimation(UnityAction onAnimationStart, UnityAction onAnimationEnd){ 
        //Write your code here
    }     
    public override void PlayExitAnimation(UnityAction onAnimationStart, UnityAction onAnimationEnd){ 
        //Write your code here
    }
}

• IsDestroyWhenClosed, if true the page will destroyed from the scene after the page closed for page inactive duration that you can set on PageManager Inspector. otherwise it will not destroyed.
• IsOverlay,  if true the page will show on top of the current top page, otherwise the current top page will closed before showin this page.
• IsWaitingPreviousPageAnimationComplete, if true the page will wait till current top page  exit animation complete first before playing this page entry animation.
• IsUsingAnimation, if true will let you to choose the way you want animate the page.
• PageAnimation, this will show every class that inherit from BasePageAnimation. It will automatically add the script and required component for the class if theres any.
• PageContent, the reference of game object that will be enabled and disabled by the PageManager when the page active/inactive.



• Page class name Settings, this will show all your serialized properties of the class you made.

• PageList, list of all your Page prefab. you can add all the page using the context menu as long as you add all the prefab on "Resources/Pages" folder.



• Default Active Page, the page prefab that will spawn after entering the playmode.
• Page Inactive TIme, the duration of page that start ticking after the page closed and destroyed after the time reach 0. it will reset if the page opened before the time reach 0.

• CanPlayOnEnable, if true will add OnEnable tween data to the list automatically, otherwise it will remove the tween data from the list. Tweak the tween setting, and the tween will be played once the object becomes enabled and active.
• Tween Data :
  • TweenIdentifier, the identifier that used for playing the tween.
  • TweenType, type of the tween that will played.
  • UsingCustomValue, let you to manually  set the From and To value for the tween if set to ture, otherwise it will used the default tween.
  • TweenDirection, set the direction of slide tween. Only can be set if UsingCustomValue set to false and the tween type is Slide.
  • TweenMode, set the tween played IN or OUT. Only can be set if UsingCustomValue set to false. Example :
    
    • Fade tween with IN tween mode will tween the canvas group alpha from 0 to 1,  otherwise 1 to 0.
    • Scale tween with IN tween mode will tween the object local scale from Vector3.zero to Vector3.one, otherwise play it backward.
    • Slide tween with IN tween mode will move the object from rect height of the rect transform to vecto3.zero, otherwise play it backward.
  • TweenEase, the ease that will used when the tween played.
  • Duration, duration of the tween that will played.
  • StartDelay, set a delayed startup for the tween. you can set the delay for multiple object at the sametime using Numeric field expressions.
  • OnTweenStart, UnityEvent that will played once the tween starting to play.
  • OnTweenComplete, UnityEvent that will played once the tween completed.
• Add New TweenData button, will add new tween data to the list and show it in the inspector.

• You can play tween using EventTrigger component by calling the PlayTween(string identifier) method and passing the tween identifier from the UITweener component.