Lumberyard
User Guide (Version 1.16)

Sky Highlight

This feature is in preview release and is subject to change.

The Sky Highlight component creates large bursts of light in the sky. You can use this component with the Lightning component to simulate the sky lighting up when a bolt of lightning flashes.

To enable the Sky Highlight component, you must enable the Lightning Arc gem. For more information, see Lightning Arc Gem.

Note

You can add multiple Sky Highlight components to your entities in a level, but the level uses only one of the Sky Highlight components. The last Sky Highlight component to activate takes priority and Lumberyard renders that component.

Example

The following is a sky highlight effect in the distance.


                Add the Sky Highlight component to your entity to
                    enable flashes of light in the sky, such lightning.

Sky Highlight Component Properties

Enabled

Sky highlight effect is rendered when the entity activates.

Default value: True

Color

Color of the sky highlight effect. The default color is a pale blue.

Default value: 204, 204, 255

Color Multiplier

Multiplier to apply to the color. You can use this parameter to adjust the color intensity at run time.

Default value: 1

Valid values: 0 to 100

Vertical Offset

Offsets the height of the sky highlight render position. Specify a value to render the sky highlight above or below the entity's transform.

Default value: 0

Valid values: 0 to 100

Size

Size of the sky highlight effect.

Default value: 10

Valid values: 0 to 100

EBus Request Bus Interface

You can use this EBus to communicate to an entity with a Sky Highlight component attached. The EBus is available at game run time and editing and can be accessed from C++, Lua, and the Script Canvas editor.

For more information about using the event bus (EBus) interface, see Working with the Event Bus (EBus) System.

Enable

Enables the sky highlight effect.

Parameters

None

Return

None

Scriptable

Yes

Disable

Disables the sky highlight effect.

Parameters

None

Return

None

Scriptable

Yes

Toggle

Toggles whether the sky highlight effect is enabled.

Parameters

None

Return

None

Scriptable

Yes

IsEnabled

Returns whether the sky highlight effect is enabled.

Parameters

None

Return

Type: Boolean

Scriptable

Yes

SetColor

Sets the color of the sky highlight.

The Color Multiplier parameter uses this value to calculate the final sky highlight color.

Parameters

None

Return

None

Scriptable

Yes

GetColor

Returns the color of the sky highlight.

Note

This value is not affected by the Color Multiplier parameter.

Parameters

None

Return

None

Scriptable

Yes

SetColorMultiplier

Sets the color multiplier of the sky highlight.

The Color parameter uses this value to calculate the final sky highlight color.

Parameters

None

Return

None

Scriptable

Yes

GetColorMultiplier

Returns the color multiplier of the sky highlight.

Parameters

None

Return

None

Scriptable

Yes

SetVerticalOffset

Sets how far to offset the sky highlight effect from the entity's transform, on the global z-axis.

Parameters

Type: Float

Return

None

Scriptable

Yes

GetVerticalOffset

Returns the vertical offset of the sky highlight.

Parameters

None

Return

Type: Float

Scriptable

Yes

SetSize

Sets the size of the sky highlight.

Parameters

Type: Float

Return

None

Scriptable

Yes

GetSize

Returns the size of the sky highlight.

Parameters

None

Return

Type: Float

Scriptable

Yes

Notification Bus Example Script

function example:OnActivate() SkyHighlightComponentRequestBus.Event.Toggle(self.entityId) SkyHighlightComponentRequestBus.Event.SetColorMultiplier(self.entityId, 10) end