mirror of
https://github.com/britzl/monarch.git
synced 2025-06-27 02:17:53 +02:00
Documentation
This commit is contained in:
Björn Ritzl
parent
d8de338a46
commit
698cdba5a4
43
README.md
43
README.md
@ -37,9 +37,9 @@ For proxies the recommended setup is to create one game object per screen and pe
|
||||
* **Timestep below Popup (number)** - Timestep to set on screen proxy when it is below a popup. This is useful when pausing animations and gameplay while a popup is open.
|
||||
* **Screen Keeps Input Focus When Below Popup (boolean)** - Check this if the screen should keep input focus when it is below a popup.
|
||||
* **Others Keep Input Focus When Below Screen (boolean)** - Check this if other screens should keep input focus when below this screen.
|
||||
* **Transition Url (url)** - Optional URL to post messages to 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 post messages to when the screen gains or loses focus (see the section on [screen focus](#screen-focus-gainloss)).
|
||||
* **Receiver Url (url)** - Optional URL to post messages to using `monarch.post()`.
|
||||
* **Transition Url (url)** - **DEPRECATED** Optional URL to post messages to when the screen is about to be shown/hidden. Use this to trigger a transition (see the section on [transitions](#transitions)).
|
||||
* **Focus Url (url)** - **DEPRECATED** Optional URL to post messages to when the screen gains or loses focus (see the section on [screen focus](#screen-focus-gainloss)).
|
||||
* **Receiver Url (url)** - **DEPRECATED** Optional URL to post messages to using `monarch.post()`.
|
||||
* **Preload (boolean)** - Check this if the screen should be preloaded and kept loaded at all times. For a collection proxy it means that it will be async loaded but not enabled at all times while not visible. This can also temporarily be achieved through the `monarch.preload()` function.
|
||||
|
||||
|
||||
@ -53,8 +53,8 @@ For factories the recommended setup is to create one game object per screen and
|
||||
* **Popup on Popup (boolean)** - Check this if the screen is a [popup](#popups) and it can be shown on top of other popups.
|
||||
* **Screen Keeps Input Focus When Below Popup (boolean)** - Check this if the screen should keep input focus when it is below a popup.
|
||||
* **Others Keep Input Focus When Below Screen (boolean)** - Check this if other screens should keep input focus when below this screen.
|
||||
* **Transition Id (hash)** - Optional id of the game object to send a message to when the screen is about to be shown/hidden. Use this to trigger a transition (see the section on [transitions](#transitions)).
|
||||
* **Focus Id (hash)** - Optional id of the game object to send a message to when the screen gains or loses focus (see the section on [screen focus](#screen-focus-gainloss)).
|
||||
* **Transition Id (hash)** - **DEPRECATED** Optional id of the game object to send a message to when the screen is about to be shown/hidden. Use this to trigger a transition (see the section on [transitions](#transitions)).
|
||||
* **Focus Id (hash)** - **DEPRECATED** Optional id of the game object to send a message to when the screen gains or loses focus (see the section on [screen focus](#screen-focus-gainloss)).
|
||||
* **Preload (boolean)** - Check this if the screen should be preloaded and kept loaded at all times. For a collection factory this means that its resources will be dynamically loaded at all times. This can also temporarily be achieved through the `monarch.preload()` function.
|
||||
|
||||
|
||||
@ -161,18 +161,30 @@ You can add optional transitions when navigating between screens. This is [descr
|
||||
|
||||
|
||||
## Screen focus gain/loss
|
||||
Monarch will send focus gain and focus loss messages if a `Focus Url` (proxy) or `Focus Id` (collectionfactory) was provided when the screen was created. The focus gained message will contain the id of the previous screen and the focus loss message will contain the id of the next screen. Example:
|
||||
Monarch will send focus gain and focus loss messages if a focus change listener has been set using `monarch.on_focus_change(screen_id, fn)`
|
||||
|
||||
DEPRECATED: ~~Monarch will send focus gain and focus loss messages if a `Focus Url` (proxy) or `Focus Id` (collectionfactory) was provided when the screen was created.~~
|
||||
|
||||
The focus gained message will contain the id of the previous screen and the focus loss message will contain the id of the next screen. Example:
|
||||
|
||||
```lua
|
||||
local monarch = require "monarch.monarch"
|
||||
|
||||
function on_message(self, message_id, message, sender)
|
||||
if message_id == monarch.FOCUS.GAINED then
|
||||
print("Focus gained, previous screen: ", message.id)
|
||||
elseif message_id == monarch.FOCUS.LOST then
|
||||
print("Focus lost, next screen: ", message.id)
|
||||
end
|
||||
function init(self)
|
||||
monarch.on_focus_changed("foobar", function(message_id, message, sender)
|
||||
if message_id == monarch.FOCUS.GAINED then
|
||||
print("Focus gained, previous screen: ", message.id)
|
||||
elseif message_id == monarch.FOCUS.LOST then
|
||||
print("Focus lost, next screen: ", message.id)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
function on_message(self, message_id, message, sender)
|
||||
monarch.on_message(message_id, message, sender)
|
||||
end
|
||||
```
|
||||
|
||||
|
||||
## Callbacks
|
||||
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. The transition is considered completed when a `transition_done` message has been received (see section on [transitions](#transitions) above).
|
||||
@ -180,10 +192,3 @@ Both the `monarch.show()` and `monarch.back()` functions take an optional callba
|
||||
|
||||
## Monarch API
|
||||
The full [Monarch API is documented here](/README_API.md).
|
||||
|
||||
|
||||
## Monarch FAQ
|
||||
|
||||
**Q**: Why am I getting `ERROR GAMEOBJECT: The collection 'default' could not be created since there is already a socket with the same name`?
|
||||
|
||||
**A**: Each collection that you use must be given a unique id. In this case you have more than one collection loaded with the id `default`. Select the root of each collection in the Outline panel and change the Name field in the properties panel from the default value of `default`.
|
||||
|
||||
@ -189,6 +189,32 @@ Post a message to a visible screen. If the screen is created through a collectio
|
||||
* `error` (string|nil) - Error message if unable to send message
|
||||
|
||||
|
||||
## monarch.on_transition(screen_id, fn)
|
||||
Set a function to be called when a screen should transition in our out. The function will receive (message_id, message, sender) with `message_id` being one of the transition constants.
|
||||
IMPORTANT! You must call `monarch.on_message(message_id, message, sender)` from the same script as this function was called.
|
||||
|
||||
**PARAMETERS**
|
||||
* `screen_id` (string|hash) - Id of the screen
|
||||
* `fn` (function) - The function to call when a transition should start
|
||||
|
||||
|
||||
## monarch.on_focus_change(screen_id, fn)
|
||||
Set a function to be called when a screen gains or loses focus. The function will receive (message_id, message, sender) with `message_id` being one of the focus change constants.
|
||||
IMPORTANT! You must call `monarch.on_message(message_id, message, sender)` from the same script as this function was called.
|
||||
|
||||
**PARAMETERS**
|
||||
* `screen_id` (string|hash) - Id of the screen
|
||||
* `fn` (function) - The function to call screen focus changes
|
||||
|
||||
|
||||
## monarch.on_post(screen_id, fn)
|
||||
Set a function to be called when `msg.post()` is called on a specific screen. IMPORTANT! You must call `monarch.on_message(message_id, message, sender)` from the same script as this function was called.
|
||||
|
||||
**PARAMETERS**
|
||||
* `screen_id` (string|hash) - Id of the screen
|
||||
* `fn` (function) - The function to call when the screen receives a message using `msg.post`
|
||||
|
||||
|
||||
## monarch.debug()
|
||||
Enable verbose logging of the internals of Monarch.
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# 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 Url` (proxy) or `Transition Id` (collectionfactory) property described above should be the URL/Id to a script with an `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.
|
||||
|
||||
Transitions are configured through the `monarch.on_transition(screen_id, fn)` function. The function defines for which screen to configure transitions and sets a function to be called when a transition should be started. This function must accept (message_id, message, sender) as arguments, with `message_id` defining which type of transition to start:
|
||||
|
||||
* `transition_show_in` (constant defined as `monarch.TRANSITION.SHOW_IN`)
|
||||
* `transition_show_out` (constant defined as `monarch.TRANSITION.SHOW_OUT`)
|
||||
@ -8,6 +10,11 @@ You can add optional transitions when navigating between screens. The default be
|
||||
|
||||
When a transition is completed it is up to the developer to send a `transition_done` (constant `monarch.TRANSITION.DONE`) message back to the sender to indicate that the transition is completed and that Monarch can continue the navigation sequence.
|
||||
|
||||
## Transition URL
|
||||
This property is deprecated and will be removed in a future version of Monarch.
|
||||
|
||||
~~It is also possible to configure transitions through the `Transition Url` (proxy) or `Transition Id` (collectionfactory) property. This property must be the URL/Id to a script with an `on_message` handlers for the transition messages mentioned above.~~
|
||||
|
||||
|
||||
## Predefined transitions
|
||||
Monarch comes with a system for setting up transitions easily in a gui_script using the `monarch.transitions.gui` module. Example:
|
||||
@ -20,15 +27,17 @@ function init(self)
|
||||
-- create transitions for the node 'root'
|
||||
-- the node will slide in/out from left and right with
|
||||
-- a specific easing, duration and delay
|
||||
self.transition = transitions.create(gui.get_node("root"))
|
||||
local transition = transitions.create(gui.get_node("root"))
|
||||
.show_in(transitions.slide_in_right, gui.EASING_OUTQUAD, 0.6, 0)
|
||||
.show_out(transitions.slide_out_left, gui.EASING_INQUAD, 0.6, 0)
|
||||
.back_in(transitions.slide_in_left, gui.EASING_OUTQUAD, 0.6, 0)
|
||||
.back_out(transitions.slide_out_right, gui.EASING_INQUAD, 0.6, 0)
|
||||
|
||||
monarch.on_transition("foobar", transition)
|
||||
end
|
||||
|
||||
function on_message(self, message_id, message, sender)
|
||||
self.transition.handle(message_id, message, sender)
|
||||
monarch.on_message(message_id, message, sender)
|
||||
-- you can also check when a transition has completed:
|
||||
if message_id == monarch.TRANSITION.DONE and message.transition == monarch.TRANSITION.SHOW_IN then
|
||||
print("Show in done!")
|
||||
@ -40,7 +49,7 @@ It is also possible to assign transitions to multiple nodes:
|
||||
|
||||
```lua
|
||||
function init(self)
|
||||
self.transition = transitions.create() -- note that no node is passed to transition.create()!
|
||||
local transition = transitions.create() -- note that no node is passed to transition.create()!
|
||||
.show_in(gui.get_node("node1"), transitions.slide_in_right, gui.EASING_OUTQUAD, 0.6, 0)
|
||||
.show_in(gui.get_node("node2"), transitions.slide_in_right, gui.EASING_OUTQUAD, 0.6, 0)
|
||||
end
|
||||
@ -111,7 +120,7 @@ end
|
||||
```
|
||||
|
||||
## Screen stack info and transitions
|
||||
The transition message sent to the Transition Url specified in the screen configuration contains additional information about the transition. For the `transition_show_in` and `transition_back_out` messages the message contains the previous screen id:
|
||||
The transition message sent transition listener script contains additional information about the transition. For the `transition_show_in` and `transition_back_out` messages the message contains the previous screen id:
|
||||
|
||||
```lua
|
||||
function on_message(self, message_id, message, sender)
|
||||
|
||||
@ -639,6 +639,7 @@ local function show_in(screen, previous_screen, reload, add_to_stack, wait_for_t
|
||||
notify_transition_listeners(M.SCREEN_TRANSITION_FAILED, { screen = screen.id })
|
||||
return
|
||||
end
|
||||
-- wait one frame so that the init() of any script have time to run before starting transitions
|
||||
cowait(0)
|
||||
reset_timestep(screen)
|
||||
transition(screen, M.TRANSITION.SHOW_IN, { previous_screen = previous_screen and previous_screen.id }, wait_for_transition)
|
||||
@ -664,6 +665,8 @@ local function back_in(screen, previous_screen, wait_for_transition, cb)
|
||||
notify_transition_listeners(M.SCREEN_TRANSITION_FAILED, { screen = screen.id })
|
||||
return
|
||||
end
|
||||
-- wait one frame so that the init() of any script have time to run before starting transitions
|
||||
cowait(0)
|
||||
reset_timestep(screen)
|
||||
if previous_screen and not previous_screen.popup then
|
||||
transition(screen, M.TRANSITION.BACK_IN, { previous_screen = previous_screen.id }, wait_for_transition)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user