Lumberyard
Legacy Reference

UI Fader Component Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

The UI Fader component flow graph nodes have been superseded by the UIe Fader component flow graph nodes. For best results, use the UIe Fader component flow graph nodes.

Use the following flow graph nodes to perform actions on the fader component.

UI:Fader:Animation Node

Animates the fader component on the specified element.

Node Inputs

Activate

Starts a fade animation.

CanvasID

Unique identifier of the fader element's canvas.

ElementID

Unique identifier of the fader element.

StartValue

Value at which the fade starts.

Valid values: 0 = Invisible | 1 = Opaque | -1= Start from the current value

TargetValue

Value at which the fade ends.

Valid values: 0 = Invisible | 1 = Opaque

Speed

Rate at which the element fades.

Valid values: 0 = Instant fade | 0.5 = Slow fade | 1 = One second fade | 2 = Fade twice as fast

Node Outputs

OnComplete

Sends a signal when the fade action is finished.

OnInterrupted

Sends a signal when the fade is interrupted by another fade starting.

UI:Fader:GetFadeValue Node

Gets the floating-point fade value of an element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Value

The floating-point fade value of the element (ElementID).

UI:Fader:SetFadeValue Node

Sets the fade value of an element.

Node Inputs

Activate

When triggered, assigns Value as the fade value of the fader component of the element.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Value

The fade value to assign to the fader component for the element.

Node Output

Done

Sends a signal when the node's action is finished.