class

PatternMaterialAnimator

Inherits Godot::Node < Godot::Object < Reference < Object

Attachable @[Tool] node for animating a target node's PatternMaterial (pattern_replace.gdshader) in both the Godot Editor and at runtime.

Supports:

  • Spritesheet Flipbook Sequences: Cycles through a comma-separated list of Faces, Glyphs, or custom frame indices at flipbook_fps (forward loop or ping-pong).
  • Palette Theme Cycling: Smoothly cross-fades or step-cycles through Palette::Theme harmonies.
  • Dissolve & Glitch Triggers: One-call methods and Inspector buttons for dissolve-in, dissolve-out, and VHS glitch bursts.

Constructors

Class methods

_godot_has_virtual_method(method_name : String) : Bool
Source
_godot_register_node_class
Source
godot_class_name
Source
godot_parent_class_name
Source

Instance methods

_godot_call_tool_button(button_name : String) : Void

Dispatches inspector tool button clicks on this object.

Source
_godot_call_virtual(method_name : String, delta : Float64) : Void

Virtual method and property dispatch hooks overridden by class registration macros. Delta timestep is received with 64-bit precision (Float64).

Source
_godot_call_virtual_with_data(method_name : String, args : Pointer(Pointer(Void)), ret : Pointer(Void)) : Void

Dispatches generic virtual methods with raw arguments and return buffer.

Source
_godot_get_property(prop_name : String, ret_ptr : Pointer(Void)) : Void

Invoked by the GDExtension bridge when retrieving an exposed @export property.

Source
_godot_set_property(prop_name : String, val_ptr : Pointer(Void)) : Void

Invoked by the GDExtension bridge when setting an exposed @export property.

Source
_process(delta : Float64) : Void

Per-frame process callback receiving delta timestep in seconds (Float64).

Source
atlas_source
Source
atlas_source=(atlas_source : AtlasSource)
Source
call(method : String, *args) : Pointer(Void)

Calls the named method on the object with variable arguments.

Source
current_cycled_colors

Computes the active (fg_color, bg_color) pair at the current @elapsed time.

Source
current_flipbook_frame_index

Computes the active 0-based sprite frame index at the current @elapsed time.

Source
cycle_speed
Source
cycle_speed=(cycle_speed : Float64)
Source
cycle_themes_csv
Source
cycle_themes_csv=(cycle_themes_csv : String)
Source
dissolve_current
Source
dissolve_duration
Source
dissolve_duration=(dissolve_duration : Float64)
Source
dissolve_in!

Starts a smooth dissolve-in transition (dissolve_amount -> 0.0).

Source
dissolve_out!

Starts a smooth dissolve-out transition (dissolve_amount -> 1.0).

Source
elapsed
Source
flipbook_enabled
Source
flipbook_enabled=(flipbook_enabled : Bool)
Source
flipbook_fps
Source
flipbook_fps=(flipbook_fps : Float64)
Source
frame_keys_csv
Source
frame_keys_csv=(frame_keys_csv : String)
Source
glitch_burst!(duration : Float64 = 0.35, intensity : Float64 = 0.65) : Void

Triggers a timed VHS glitch tear burst.

Source
palette_cycle_enabled
Source
palette_cycle_enabled=(palette_cycle_enabled : Bool)
Source
ping_pong
Source
ping_pong=(ping_pong : Bool)
Source
resolved_cycle_themes

Resolves the list of Palette::ThemeColors from cycle_themes_csv.

Source
resolved_frame_indices

Resolves the list of 0-based atlas frame indices from frame_keys_csv and atlas_source.

Source
smooth_palette_lerp
Source
smooth_palette_lerp=(smooth_palette_lerp : Bool)
Source
step_animation(delta : Float64) : Void

Advances all active flipbook, palette cycle, dissolve, and glitch animations by delta seconds.

Source
target_node_path
Source
target_node_path=(target_node_path : String)
Source
trigger_glitch_button

Triggers a timed VHS glitch tear burst from the Godot Inspector.

Source

Macros

autoload(*args, **kwargs)

DSL directives for in-body autoload configuration

Source
autoload_node(*args, **kwargs)
Source
build
Source
create
Source

Nested types