Skip to content

Commit 2010eee

Browse files
committed
Updated README
1 parent 3c0d8da commit 2010eee

File tree

2 files changed

+9
-20
lines changed

2 files changed

+9
-20
lines changed

Assets/Scenes.meta

-8
This file was deleted.

Assets/UIManager/README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,25 @@ The UI Manager is a stack-based UI controller class. It is designed to make push
77
The core functionality of UI Manager is made up of only two simple classes: `UIManager` and `Screen`.
88

99
### UIManager
10-
`UIManager` is responsible for instantiating and maintaining the screen stack. When you want to push or pop a screen to the stack, you interact with `UIManager`. `UIManager` has a few prerequisites that should be understood when using it:
10+
`UIManager` is responsible for instantiating and maintaining the screen stack. When you want to push or pop a screen to the stack, you interact with `UIManager`.
11+
12+
`UIManager` has a few prerequisites that should be understood when using it:
1113

1214
> ### Prerequisites
13-
>
14-
> > 1. **IUpdateTransmitter**
15-
> > UIManager is built on top of the IUpdateTransmitter and IUpdateObserver interfaces. UIManager is
16-
> > an IUpdateObserver that needs to register with an IUpdateTransmitter in order to receive
17-
> > 'OnUpdate' calls every frame.
1815
> >
19-
> > 2. **Screen Prefab Folder**
16+
> > 1. **Screen Prefab Folder**
2017
> > The UIManager looks for screen prefabs by name inside a specific folder that you specify in the
2118
> > constructor. This folder must reside within a folder called 'Resources' in the Unity project.
2219
> >
2320
> > ![Prefab Directory](_images/prefab_directory.png)
2421
> > *Example of a screen prefab directory structure.*
2522
> >
2623
> >
27-
> > 3. **UI Root Canvas**
24+
> > 2. **UI Root Canvas**
2825
> > The UI Manager organizes all screens underneath a root Canvas object. You must provide the UI
2926
> > Manager what Canvas object you want to use for this purpose.
3027
> >
31-
> > 4. ***Optional* UI Camera**
28+
> > 3. ***Optional* UI Camera**
3229
> > If you want to render your UI with a seperate Unity Camera you can pass it to the UIManager
3330
> > inside the constructor. By default, Unity does not use a seperate Camera to render UI elements,
3431
> > so this isn't necessary unless you need it.
@@ -96,13 +93,13 @@ The core functionality of UI Manager is made up of only two simple classes: `UIM
9693
> to you as the developer to decide how to use in your project.
9794
>
9895
> ### Core Fields
99-
> > ####keepCached
96+
> > #### keepCached
10097
> > `UIManager` gives you the option to disable a screen object instead of destroying it completely when
10198
> > the screen is popped from the stack. This will keep the screen object cached in memory and when it is
10299
> > pushed to the stack again will reuse the cached object instead of instancing a new one from the prefab.
103100
>
104101
> ### Core Methods
105-
> > ####OnSetup
102+
> > #### OnSetup
106103
> > `OnSetup` is called after instantiating a screen prefab. It is only called once for the lifecycle of
107104
> > the `Screen`.
108105
> > #### OnPush
@@ -139,7 +136,7 @@ Included with the core `UIManager` classes is an example scene with example scri
139136
Open the scene *UIExample* inside the *Example* folder.
140137
141138
Press play in the editor and play with the example to get a grasp of how it is organized.
142-
When you're ready to look at the setup process and various screens in detail you should start by looking at the script `UI/Examples/Scripts/GameManager.cs`
139+
When you're ready to look at the setup process and various screens in detail you should start by looking at the script `UIManager/Examples/Scripts/GameManager.cs`
143140
144141
This script is the entry point for the example and is where the `UIManager` is setup and the first screen is pushed onto the stack.
145142

0 commit comments

Comments
 (0)