Flash Screen

Flash Screen

Flashes the screen with a specified color for a given duration.

Properties

System

Name	Explanation	Type
Color	The color to flash the screen with.	Color
Duration (milliseconds)	The duration to flash the screen in milliseconds.	Variable or Value
Include User Interface	Whether to include the user interface in the screen flash.	Toggle
Run Asynchronously	Whether the flash runs asynchronously, allowing subsequent commands to execute without waiting.	Toggle

Examples

Flash Screen White for One Second

Flashes the screen white for 1000 milliseconds.

Code ScriptVisual Script

flash_screen(#FFFFFF, 1000);

{"Data":{"FlashColor":"#FFFFFF","FlashDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"IsAsynchronousOperation":false,"IsUserInterfaceIncluded":false,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.FlashScreenCommand"}

Flash Screen Asynchronously

Flashes the screen white for 1000 milliseconds without blocking subsequent commands.

Code ScriptVisual Script

flash_screen(#FFFFFF, 1000, async);

{"Data":{"FlashColor":"#FFFFFF","FlashDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"IsAsynchronousOperation":true,"IsUserInterfaceIncluded":false,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.FlashScreenCommand"}

Flash Screen Including the User Interface

Flashes the screen white for 1000 milliseconds including the user interface layer.

Code ScriptVisual Script

flash_screen(#FFFFFF, 1000, include_ui);

{"Data":{"FlashColor":"#FFFFFF","FlashDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"IsAsynchronousOperation":false,"IsUserInterfaceIncluded":true,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.FlashScreenCommand"}