Skip to content

GFFParams

GFFParams carries intensity, duration and arbitrary data for an effect.

Creating Params

# intensity only
var p = GFFParams.create(1.0)

# intensity + duration
var p = GFFParams.create(1.0, 0.3)

Chaining Data

var p = GFFParams.create(1.0, 0.2)\
    .with_color("color", Color.RED)\
    .with_float("amplitude", 0.5)\
    .with_bool("loop", false)

Reading Data in Custom Effects

func _execute(node: Node, params: GFFParams) -> void:
    var amplitude = params.get_float("amplitude", 0.2)
    var color = params.get_color("color", Color.WHITE)