Predefined effects for use with the Orchestrator.
move_to(pos: Vec2, dur: float = 0.0, ease: Callable[[float], float] | None = None) → Effectmove_to(pos: Vec2, dur: float = 0.0, ease: Callable[[float], float] | None = None) → EffectCreate a move-to effect.
Args
pos : Target position.dur : Duration in seconds.ease : Easing function (t -> t).Returns
Effect : The move-to effect.
scale_to(scale: Vec2, dur: float = 0.0, ease: Callable[[float], float] | None = None) → Effectscale_to(scale: Vec2, dur: float = 0.0, ease: Callable[[float], float] | None = None) → EffectCreate a scale-to effect.
Args
scale : Target scale exact dimensions.dur : Duration in seconds.ease : Easing function (t -> t).Returns
Effect : The scale-to effect.
scale_by(scale: float, dur: float = 0.0, ease: Callable[[float], float] | None = None) → Effectscale_by(scale: float, dur: float = 0.0, ease: Callable[[float], float] | None = None) → EffectCreate a scale-by effect.
Args
scale : Delta scalar to apply to the scale.dur : Duration in seconds.ease : Easing function (t -> t).Returns
Effect : The scale-by effect.
rotate_to(angle: float, clockwise: bool = True, dur: float = 0.0, ease: Callable[[float], float] | None = None) → Effectrotate_to(angle: float, clockwise: bool = True, dur: float = 0.0, ease: Callable[[float], float] | None = None) → EffectCreate a rotate-to effect.
Args
angle : Target angle in radians.clockwise : Direction of rotation. True for clockwise, False for counterclockwise.dur : Duration in seconds.ease : Easing function (t -> t).Returns
Effect : The rotate-to effect.
rotate_by(delta: float, clockwise: bool = True, dur: float = 0.0, ease: Callable[[float], float] | None = None) → Effectrotate_by(delta: float, clockwise: bool = True, dur: float = 0.0, ease: Callable[[float], float] | None = None) → EffectCreate a rotate-by effect.
Args
delta : Delta angle in radians to rotate by in radians.clockwise : Direction of rotation. True for clockwise, False for counterclockwise.dur : Duration in seconds.ease : Easing function (t -> t).Returns
Effect : The rotate-by effect.
shake(amp: float, freq: float, dur: float) → Effectshake(amp: float, freq: float, dur: float) → EffectCreate a shake effect.
Args
amp : Shake amplitude in pixels.freq : Shake frequency in Hz.dur : Duration in seconds.Returns
Effect : The shake effect.
call(callback: Callable[[], None]) → Effectcall(callback: Callable[[], None]) → EffectCreate an effect that calls a function.
Args
callback : Function to call when this step is reached.Returns
Effect : The call effect.