Skip to content

Quick Start

The fastest way to see Game Feel Flow in action is with the GFUtil helpers.

One-shot Effects

# Shake
GFUtil.shake(target_node, 1.0)

# Flash white
GFUtil.flash(target_node, Color.WHITE)

# Scale punch
GFUtil.scale(target_node, 1.0)

# Freeze frame
GFUtil.freeze(0.05)

Using GFFPlayer

For reusable, configurable effects, use the GFFPlayer node:

  1. Add a GFFPlayer node as a child of the target node.
  2. In the Inspector, create a Combo.
  3. Add effects to the Combo.
  4. Trigger it from code:
$GFFPlayer.play("Combo_1")

Play by Effect Name

You can also play individual effects by their registered name:

$GFFPlayer.play("shake", 1.0)

Next

Learn how to build your first timeline-based Combo: Your First Combo