Skip to content

Show Screen

Show Screen

Restores the screen to being visible 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 be rendered when showing the screen. Toggle
Render User Interface Whether the user interface should be rendered when showing the screen. Toggle
Transition The transition effect to use when showing the screen. Scene Transition

Examples

Show Screen with a Fade In Transition

Restores the screen to visible using a fade-in transition over 1000 milliseconds with a black color.

show_screen(fade_in(linear(1000), #000000));

{"Data":{"IsAsynchronousTransition":0,"IsRenderingScene":1,"IsRenderingUserInterface":1,"Transition":{"$":"FadeInSceneTransition","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.ShowScreenCommand"}

Show Screen Instantly

Restores the screen to visible immediately without any transition effect.

show_screen(instant);

{"Data":{"IsAsynchronousTransition":0,"IsRenderingScene":1,"IsRenderingUserInterface":1,"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.ShowScreenCommand"}

Show Screen Asynchronously While Hiding the User Interface

Fades in the screen asynchronously while keeping the user interface hidden.

show_screen(fade_in(linear(1000), #000000), async, hide_ui);

{"Data":{"IsAsynchronousTransition":1,"IsRenderingScene":1,"IsRenderingUserInterface":0,"Transition":{"$":"FadeInSceneTransition","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.ShowScreenCommand"}