Hide Screen

Hide Screen

Hide the screen using a specified transition effect.

Properties

System

Name	Explanation	Type
Asynchronous Transition	Whether the transition runs asynchronously, allowing subsequent commands to execute without waiting.	Toggle
Render Scene	Whether the scene should continue to be rendered after hiding.	Toggle
Render User Interface	Whether the user interface should continue to be rendered after hiding.	Toggle
Transition	The transition effect to use when hiding the screen.	Scene Transition

Examples

Hide Screen with a Fade Out Transition

Hides the screen using a fade-out transition over 1000 milliseconds with a black color.

Code ScriptVisual Script

hide_screen(fade_out(linear(1000), #000000));

{"Data":{"IsAsynchronousTransition":false,"IsRenderingScene":false,"IsRenderingUserInterface":false,"Transition":{"Duration":"00:00:01","Color":"#000000","TypeName":"MAR.Game.Shared.Models.Transitions.Scene.FadeOutSceneTransition"},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.HideScreenCommand"}

Hide Screen Instantly

Hides the screen immediately without any transition effect.

Code ScriptVisual Script

hide_screen(instant);

{"Data":{"IsAsynchronousTransition":false,"IsRenderingScene":false,"IsRenderingUserInterface":false,"Transition":{"TypeName":"MAR.Game.Shared.Models.Transitions.Scene.InstantSceneTransition"},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.HideScreenCommand"}

Hide Screen Asynchronously While Continuing to Render the Scene

Fades out the screen asynchronously while keeping the scene rendering active behind the transition.

Code ScriptVisual Script

hide_screen(fade_out(linear(1000), #000000), async, render_scene);

{"Data":{"IsAsynchronousTransition":true,"IsRenderingScene":true,"IsRenderingUserInterface":false,"Transition":{"Duration":"00:00:01","Color":"#000000","TypeName":"MAR.Game.Shared.Models.Transitions.Scene.FadeOutSceneTransition"},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.HideScreenCommand"}