Skip to content

Tint Screen

Tint Screen

Applies or remove a color tint on the screen using an easing function.

Properties

System

Name Explanation Type
Color The color to tint the screen with. Color
Easing Function The easing function that controls the tint transition over time. Easing Function
Enable Tint Whether to apply a tint to the screen. When disabled, the tint is removed. Toggle
Run Asynchronously Whether the tint runs asynchronously, allowing subsequent commands to execute without waiting. Toggle

Examples

Tint Screen Red with a Linear Transition

Applies a red tint to the screen over 1000 milliseconds using a linear easing function.

tint_screen(#FF0000, linear(1000));

{"Data":{"EasingFunction":{"$":"LinearEasingFunction","Name":"Linear","Duration":"00:00:01","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronousOperation":0,"IsTinting":1,"TintColor":"1,0,0,1","Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.TintScreenCommand"}

Remove Screen Tint with a Linear Transition

Removes the screen tint over 500 milliseconds using a linear easing function.

tint_screen(reset, linear(500));

{"Data":{"EasingFunction":{"$":"LinearEasingFunction","Name":"Linear","Duration":"00:00:00.5000000","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronousOperation":0,"IsTinting":0,"TintColor":"0,0,0,0","Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.TintScreenCommand"}

Tint Screen Asynchronously with a Bounce Effect

Applies a red tint using a bounce easing function over 2000 milliseconds without blocking subsequent commands.

tint_screen(#FF0000, bounce(2000), async);

{"Data":{"EasingFunction":{"$":"BounceEasingFunction","Bounces":3,"Elasticity":0.5,"Gravity":1.5,"Name":"Bounce","Duration":"00:00:02","IsFinished":0,"IsReversed":0,"Metadata":null},"IsAsynchronousOperation":1,"IsTinting":1,"TintColor":"1,0,0,1","Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.TintScreenCommand"}