Gui issue using Monarch transitions

ItsPixel · June 26, 2019, 3:04am

Hi guys!
I am started to use monarch for switching scenes and it worked fine until I tried to add transitions.
After adding transition url, gui is started to act kinda weird.
It stops to redirect to the correct scene and gui is not removed as expected.

To switch scenes I use proxy collection with monarch.show(hash(“start”))
Code of transition is very simple:

function on_message(self, message_id, message, sender)
	print("GUI transition - message_id: " .. message_id)
	pprint(message)
	if message_id == hash("transition_show_in") then 
		msg.post(sender, monarch.TRANSITION.DONE)
	end
end

Cannot find where is the problem, can somebody advice something?

britzl · June 26, 2019, 3:04am

Hi. So the transition isn’t actually doing anything? I’m guessing that since it is instantaneous that this messes with monarch. You can try to add a timer before sending the transition done message just to verify.

ItsPixel · June 26, 2019, 7:07pm

Does not help, will continue to investigate.

britzl · June 26, 2019, 8:34pm

I can take a look if you can share a zip with a repro case. Preferably in a GitHub issue or here.

ItsPixel · June 27, 2019, 6:54pm

Well I have found that there is missing monarch_screen_transition_out_finished.
Not sure why, but it does not send done message.

Proccess looks like this:

monarch.show(‘start’) //preloaded
DEBUG:SCRIPT: Transition: [transition_show_in]
DEBUG:SCRIPT: Transition: [transition_done]
monarch.show(‘next_scene’)
DEBUG:SCRIPT: Transition: [transition_show_out]
// should be transition_done, but missing it
DEBUG:SCRIPT: Transition: [transition_show_in]
DEBUG:SCRIPT: Transition: [transition_done]

Defined transitions:

function init(self)
	self.transition = transitions.create(gui.get_node("box"))
	.show_in(transitions.fade_out, gui.EASING_LINEAR, 2)
	.show_out(transitions.fade_in, gui.EASING_LINEAR, 2)
end

function on_message(self, message_id, message, sender)
	self.transition.handle(message_id, message, sender)
end

Seems it does not wait till transition finishes and moves to the next transition.

britzl · June 27, 2019, 9:22pm

Ok. Can you create a minimal repro case and share it with me?

ItsPixel · June 28, 2019, 10:32pm

Uploaded: https://bitbucket.org/seqq86/monarch/src/master

britzl · June 29, 2019, 1:37pm

Ok, so I took a look at your project. Some comments:

You have two screens, level1 and start.
Both screens use the same transition url /gui#transitions
The transition logic at /gui#transitions defines a transition for show_out and show_in
When you click you alternate between showing level1 and start

The problem is that when you show one screen it triggers the show_in transition and at the same time you hide the other screen which triggers the show_out transition. This means that the transition logic in /gui#transitions gets invoked twice and at the same time. Only one of these will finish.

The solution is to have the transition handler set up per screen. Meaning that level1 has one transition url and start has another. This way they won’t conflict like they do today.

ItsPixel · June 29, 2019, 2:05pm

Thank you for your time. But what if I plan to have 70+ scenes? If there is possibility to run transitions in sequance?

britzl · June 29, 2019, 3:38pm

You could create a transition instance per screen at runtime:

local transitions = require "monarch.transitions.gui"
local monarch = require "monarch.monarch"

local function get_transition(self, screen)
	if not self.transitions[screen] then
		self.transitions[screen] = transitions.create(some_node)
			.show_in(transitions.fade_in, gui.EASING_OUTQUAD, 0.6, 0)
			.show_out(transitions.fade_out, gui.EASING_INQUAD, 0.6, 0)
	end
	return self.transitions[screen]
end

function init(self)
	self.transitions = {}
end

function on_message(self, message_id, message, sender)
	if message_id == monarch.TRANSITION.SHOW_IN or message_id == monarch.TRANSITION.SHOW_OUT then
		local transition = get_transition(self, message.screen)
		transition.handle(message_id, message, sender)
	end
end

ItsPixel · June 29, 2019, 5:28pm

Thank you for your answers!

ItsPixel · June 30, 2019, 6:03pm

Well… pretty strange transition_show_in does not sends screen in message.

britzl · June 30, 2019, 7:52pm

Hmm, it should. What does message contain?

And used here:

github.com

britzl/monarch/blob/master/monarch/monarch.lua#L464


		end
		active_transition_count = active_transition_count - 1
		notify_transition_listeners(M.SCREEN_TRANSITION_OUT_FINISHED, { screen = screen.id, next_screen = next_screen.id })
	end)
end


local function show_in(screen, previous_screen, reload, add_to_stack, cb)
	log("show_in()", screen.id)
	run_coroutine(screen, cb, function()
		active_transition_count = active_transition_count + 1
		notify_transition_listeners(M.SCREEN_TRANSITION_IN_STARTED, { screen = screen.id, previous_screen = previous_screen and previous_screen.id })
		change_context(screen)
		if reload and screen.loaded then
			log("show_in() reloading", screen.id)
			unload(screen, reload)
			-- we need to wait here in case the unloaded screen contained any screens
			-- if this is the case we need to let these sub-screens have their final()
			-- functions called so that they have time to call unregister()
			cowait(0)
			cowait(0)
		end

And here:

github.com

britzl/monarch/blob/master/monarch/monarch.lua#L492


		focus_gained(screen, previous_screen)
		active_transition_count = active_transition_count - 1
		notify_transition_listeners(M.SCREEN_TRANSITION_IN_FINISHED, { screen = screen.id, previous_screen = previous_screen and previous_screen.id })
	end)
end


local function back_in(screen, previous_screen, cb)
	log("back_in()", screen.id)
	run_coroutine(screen, cb, function()
		active_transition_count = active_transition_count + 1
		notify_transition_listeners(M.SCREEN_TRANSITION_IN_STARTED, { screen = screen.id, previous_screen = previous_screen and previous_screen.id })
		change_context(screen)
		load(screen)
		reset_timestep(screen)
		if previous_screen and not previous_screen.popup then
			transition(screen, M.TRANSITION.BACK_IN, { previous_screen = previous_screen.id })
		end
		acquire_input(screen)
		focus_gained(screen, previous_screen)
		active_transition_count = active_transition_count - 1
		notify_transition_listeners(M.SCREEN_TRANSITION_IN_FINISHED, { screen = screen.id, previous_screen = previous_screen and previous_screen.id })

hungle · September 12, 2019, 5:50am

I’m having the same issue that you described.

I have one scene and when I reload it (while that scene is loaded), the fade out transition does not work but only the fade in transition work.

Can you suggest any simple solution for this?

britzl · September 12, 2019, 5:57am

I would need to know more about the problem. Can you please create a ticket and also share a repro case so that I can test and see if it’s possible to create a fix:

hungle · September 12, 2019, 6:31am

Created the ticket and provided the repro case!

britzl · September 12, 2019, 6:44am

Thank you. I will take a look later.