ShakerComponent3D is a class that extends ShakerBase3D to provide 3D shaking functionality in Godot 4. It can be used to add shaking effects to Node3D nodes in a scene..

Starts the shake effect.

func play_shake() -> void

var shaker = get_node("ShakerComponent3D")
shaker.play_shake()

None

Stops the shake effect with a fade-out.

func stop_shake() -> void

var shaker = get_node("ShakerComponent3D")
shaker.stop_shake()

None

Immediately stops the shake effect.

func force_stop_shake() -> void

var shaker = get_node("ShakerComponent3D")
shaker.force_stop_shake()

None

Adds an external shake effect to the component.

func shake(shaker_preset: ShakerPreset3D, mode: ShakeAddMode = ShakeAddMode.add, duration: float = 1.0, speed: float = 1.0, intensity: float = 1.0, fade_in: float = 0.25, fade_out: float = 0.25) -> void

var shaker = get_node("ShakerComponent3D")
var preset = preload("res://shaker_presets/earthquake.tres")
shaker.shake(preset, ShakerComponent3D.ShakeAddMode.add, 2.0, 1.5, 0.8)

None

Defines how a new shake effect is added to existing ones.

• add: Adds the new shake effect to existing ones
• override: Overrides existing shake effects with the new one

• shake_started: Emitted when the shake effect starts
• shake_finished: Emitted when the shake effect finishes
• shake_fading_out: Emitted when the shake effect starts fading out