Skip to content

Shake Screen

Shake Screen

Shakes the camera with configurable intensity on each axis for a specified duration.

Properties

System

Name Explanation Type
Duration (milliseconds) The duration to shake the screen in milliseconds. Variable or Value
Run Asynchronously Whether the shake runs asynchronously, allowing subsequent commands to execute without waiting. Toggle
X The shake intensity on the X axis. Variable or Value
Y The shake intensity on the Y axis. Variable or Value
Z The shake intensity on the Z axis. Variable or Value

Examples

Shake Screen on the X and Y Axes

Shakes the screen for 1000 milliseconds with intensity 5 on both the X and Y axes.

shake_screen(1000, x: 5, y: 5);

{"Data":{"IsAsynchronousOperation":false,"ShakeDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.ShakeScreenCommand"}

Shake Screen Asynchronously on All Axes

Shakes the screen for 1000 milliseconds on all three axes without blocking subsequent commands.

shake_screen(1000, x: 5, y: 5, z: 3, async);

{"Data":{"IsAsynchronousOperation":true,"ShakeDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.ShakeScreenCommand"}