Skip to content

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.

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

{"Data":{"IsAsynchronousTransition":0,"IsRenderingScene":0,"IsRenderingUserInterface":0,"Transition":{"$":"FadeOutSceneTransition","Color":"0,0,0,1","BlendMode":0,"Duration":"00:00:01","EasingFunction":{"$":"LinearEasingFunction","Name":"Linear","Duration":"00:00:01","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronous":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.HideScreenCommand"}

Hide Screen Instantly

Hides the screen immediately without any transition effect.

hide_screen(instant);

{"Data":{"IsAsynchronousTransition":0,"IsRenderingScene":0,"IsRenderingUserInterface":0,"Transition":{"$":"InstantSceneTransition","Duration":"00:00:00","BlendMode":0,"EasingFunction":{"$":"LinearEasingFunction","Name":"Linear","Duration":"00:00:01","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronous":0,"Metadata":null},"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.

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

{"Data":{"IsAsynchronousTransition":1,"IsRenderingScene":1,"IsRenderingUserInterface":0,"Transition":{"$":"FadeOutSceneTransition","Color":"0,0,0,1","BlendMode":0,"Duration":"00:00:01","EasingFunction":{"$":"LinearEasingFunction","Name":"Linear","Duration":"00:00:01","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronous":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.HideScreenCommand"}