Skip to content

Adjust Light

Adjust Light

Modifies the light properties of an entity or doodad over a specified duration.

Properties

System

Name Explanation Type
Duration The duration to adjust the light in milliseconds. Variable or Value
Intensity The intensity value of the light. Variable or Value
Intensity Enabled Whether the intensity adjustment is enabled. Toggle
Pitch The pitch of the light direction in degrees. Variable or Value
Pitch Enabled Whether the pitch adjustment is enabled. Toggle
Radius The radius of the light. Variable or Value
Radius Enabled Whether the radius adjustment is enabled. Toggle
Roll The roll of the light in degrees. Variable or Value
Roll Enabled Whether the roll adjustment is enabled. Toggle
Run Asynchronously Whether the adjustment runs asynchronously, allowing subsequent commands to execute without waiting. Toggle
Target The target entity or doodad whose light to adjust. Physics Object Reference
Use As Delta Values When enabled, adjusts the light by the specified amount relative to its current value rather than setting it to an absolute value. Toggle
X The X offset of the light position. Variable or Value
X Enabled Whether the X offset adjustment is enabled. Toggle
Y The Y offset of the light position. Variable or Value
Y Enabled Whether the Y offset adjustment is enabled. Toggle
Yaw The yaw of the light direction in degrees. Variable or Value
Yaw Enabled Whether the yaw adjustment is enabled. Toggle
Z The Z offset of the light position. Variable or Value
Z Enabled Whether the Z offset adjustment is enabled. Toggle

Examples

Rotate Entity 0 Light Yaw by 45 Degrees Over 500 Milliseconds

This adjusts the yaw of entity 0's light by 45 degrees relative to its current value over 500 milliseconds.

adjust_light(entity(0), 500, yaw: 45, delta);

{"Data":{"AdjustmentDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"500","VariableIndex":0,"Metadata":null},"Intensity":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"IsAsynchronousOperation":false,"IsDeltaOperation":true,"IsIntensityEnabled":false,"IsOffsetXEnabled":false,"IsOffsetYEnabled":false,"IsOffsetZEnabled":false,"IsPitchEnabled":false,"IsRadiusEnabled":false,"IsRollEnabled":false,"IsYawEnabled":true,"OffsetX":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"OffsetY":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"OffsetZ":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Pitch":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Roll":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Target":{"ReferenceType":0,"Index":0,"Metadata":null},"Yaw":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"45","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapLightAdjustmentCommand"}

Set Doodad 0 Light Roll to 180 Degrees Over 1 Second

This sets the roll of doodad 0's light to 180 degrees over 1000 milliseconds.

adjust_light(doodad(0), 1000, roll: 180);

{"Data":{"AdjustmentDuration":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1000","VariableIndex":0,"Metadata":null},"Intensity":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"IsAsynchronousOperation":false,"IsDeltaOperation":false,"IsIntensityEnabled":false,"IsOffsetXEnabled":false,"IsOffsetYEnabled":false,"IsOffsetZEnabled":false,"IsPitchEnabled":false,"IsRadiusEnabled":false,"IsRollEnabled":true,"IsYawEnabled":false,"OffsetX":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"OffsetY":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"OffsetZ":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Pitch":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Roll":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"180","VariableIndex":0,"Metadata":null},"Target":{"ReferenceType":1,"Index":0,"Metadata":null},"Yaw":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapLightAdjustmentCommand"}