diff --git a/README.md b/README.md index 52bf235..40ddeb5 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ https://github.com/britzl/monarch/archive/master.zip Using Monarch requires that screens are created in a certain way. Once you have one or more screens created you can start navigating between the screens. ## Creating screens -Monarch screens are created in individual collections and loaded through collection proxies. The recommended setup is to create one game object per screen and per game object attach a collection proxy component and an instance of the ````screen.script```` provided by Monarch. The screen.script will take care of the setup of the screen. All you need to do is to make sure that the script properties on the ````screen.script```` are correct: +Monarch screens are created in individual collections and loaded through collection proxies. The recommended setup is to create one game object per screen and per game object attach a collection proxy component and an instance of the ```screen.script``` provided by Monarch. The screen.script will take care of the setup of the screen. All you need to do is to make sure that the script properties on the ```screen.script``` are correct: -* **Screen Proxy (url)** - The URL to the collection proxy component containing the actual screen. Defaults to ````#collectionproxy```` -* **Screen Id (hash)** - A unique id that can be used to reference the screen when navigating your app -* **Popup (boolean)** - Check this if the screen should be treated as a [popup](#popups) -* **Transition Url (url)** - Optional URL to call when the screen is about to be shown/hidden. Use this to trigger a transition (see the section on [transitions](#transitions)) -* **Focus Url (url)** - Optional URL to call when the screen gains or loses focus. +* **Screen Proxy (url)** - The URL to the collection proxy component containing the actual screen. Defaults to ```#collectionproxy```. +* **Screen Id (hash)** - A unique id that can be used to reference the screen when navigating your app. +* **Popup (boolean)** - Check this if the screen should be treated as a [popup](#popups). +* **Transition Url (url)** - Optional URL to call when the screen is about to be shown/hidden. Use this to trigger a transition (see the section on [transitions](#transitions)). +* **Focus Url (url)** - Optional URL to call when the screen gains or loses focus (see the section on [screen focus](#screen-focus-gainloss)). ![](docs/setup.png) @@ -24,32 +24,38 @@ Monarch screens are created in individual collections and loaded through collect The navigation in Monarch is based around a stack of screens. When a screen is shown it is pushed to the top of the stack. When going back to a previous screen the topmost screen on the stack is removed. Example: * Showing screen A -* Stack is ````[A]```` +* Stack is ```[A]``` * Showing screen B -* Stack is ````[A, B]```` - (B is on top) +* Stack is ```[A, B]``` - (B is on top) * Going back -* Stack is ````[A]```` +* Stack is ```[A]``` ### Showing a new screen You show a screen in one of two ways: -1. Post a ````show```` message to the ````screen.script```` -2. Call ````monarch.show()```` (see below) +1. Post a ```show``` message to the ```screen.script``` +2. Call ```monarch.show()``` (see below) Showing a screen will push it to the top of the stack and trigger an optional transition. The previous screen will be hidden (with an optional transition) unless the screen to be shown is a [popup](#popups). #### Preventing duplicates in the stack -You can pass an optional ````clear```` flag when showing a screen (either as a key value pair in the options table when calling ````monarch.show()```` or in the message). If the clear flag is set Monarch will search the stack for the screen in question. If the screen already exists in the stack and the clear flag is set Monarch will remove all screens between the current top and the screen in question. Example: +You can pass an optional ```clear``` flag when showing a screen (either as a key value pair in the options table when calling ```monarch.show()``` or in the message). If the clear flag is set Monarch will search the stack for the screen in question. If the screen already exists in the stack and the ```clear``` flag is set Monarch will remove all screens between the current top and the screen in question. Example: -* Stack is ````[A, B, C, D]```` - (D is on top) -* A call to ````monarch.show(B, { clear = true })```` is made -* Stack is ````[A, B]```` +* Stack is ```[A, B, C, D]``` - (D is on top) +* A call to ```monarch.show(B, { clear = true })``` is made +* Stack is ```[A, B]``` + +As opposed to if the ```clear``` flag was not set: + +* Stack is ```[A, B, C, D]``` - (D is on top) +* A call to ```monarch.show(B, { clear = false })``` is made +* Stack is ```[A, B, C, D, B]``` - (B is on top) ### Going back to a previous screen You navigate back in the screen hierarchy in one of two ways: -1. Post a ````back```` message to the ````screen.script```` -2. Call ````monarch.back()```` (see below) +1. Post a ```back``` message to the ```screen.script``` +2. Call ```monarch.back()``` (see below) ## Input focus @@ -58,21 +64,21 @@ Monarch will acquire and release input focus on the game objects containing the ## Popups A screen that is flagged as a popup (see list of screen properties above) will be treated slightly differently when it comes to navigation. If a popup is at the top of the stack (ie currently shown) and another screen or popup is shown then the current popup will be removed from the stack. This means that it is not possible to have a popup anywhere in the stack but the top. This also means that you cannot navigate back to a popup since popups can only exist on the top of the stack. Another important difference between normal screens and popups is that when a popup is shown on top of a non-popup the current top screen will not be unloaded and instead remain visible in the background. -* Stack is ````[A, B]```` -* A call to ````monarch.show(C)```` is made and C is a popup -* Stack is ````[A, B, C]```` -* A call to ````monarch.show(D)```` -* Stack is ````[A, B, D]```` +* Stack is ```[A, B]``` +* A call to ```monarch.show(C)``` is made and C is a popup +* Stack is ```[A, B, C]``` +* A call to ```monarch.show(D)``` +* Stack is ```[A, B, D]``` ## Transitions -You can add optional transitions when navigating between screens. The default behavior is that screen navigation is instant but if you have defined a transition for a screen Monarch will wait until the transition is completed before proceeding. The Transition Show In/Out and Transition Back In/Out properties described above should be URLs to one or more scripts with on_message handlers for the following messages: +You can add optional transitions when navigating between screens. The default behavior is that screen navigation is instant but if you have defined a transition for a screen Monarch will wait until the transition is completed before proceeding. The Transition Url property described above should be the URL to a script with an ```on_message``` handlers for the following messages: -* ````transition_show_in```` -* ````transition_show_out```` -* ````transition_back_in```` -* ````transition_back_out```` +* ```transition_show_in``` +* ```transition_show_out``` +* ```transition_back_in``` +* ``transition_back_out``` -When a transition is completed it is up to the developer to send a ````transition_done```` message back to the sender to indicate that the transition is completed and that Monarch can continue the navigation sequence. Monarch comes with a system for setting up transitions easily in a gui_script. Example: +When a transition is completed it is up to the developer to send a ```transition_done``` message back to the sender to indicate that the transition is completed and that Monarch can continue the navigation sequence. Monarch comes with a system for setting up transitions easily in a gui_script. Example: local transitions = require "monarch.transitions.gui" @@ -92,7 +98,7 @@ When a transition is completed it is up to the developer to send a ````transitio end ## Screen focus gain/loss -Monarch will send focus gain and focus loss messages if a focus url was provided when the screen was created. Example: +Monarch will send focus gain and focus loss messages if a Focus Url was provided when the screen was created. Example: local monarch = require "monarch.monarch" @@ -105,7 +111,7 @@ Monarch will send focus gain and focus loss messages if a focus url was provided end ## Callbacks -Both the ```monarch.show()``` and ```monarch.back()``` functions take an optional callback function that will be invoked when the transition is completed. Note that this will not take into account when custom transitions are completed. The callback will be invoked immediately when the loading and unloading of collections are done and when the internal state of Monarch has completed the navigation. +Both the ```monarch.show()``` and ```monarch.back()``` functions take an optional callback function that will be invoked when the ```transition_show_in``` (or the ```transition_back_in``` in the case of a ```monarch.back()``` call) transition is completed. Tthe transition is considered completed when a ```transition_done``` message has been received (see section on [transitions](#transitions) above). ## Monarch API