YarnEffects
reusable animation effects for dialogue presentation.
class_name YarnEffects
extends RefCountedInherits from RefCounted
#Constants
#DEFAULT_FADE_DURATION
const DEFAULT_FADE_DURATION = 0.25#Methods
#fade_alpha_async(CanvasItem, float, float, float, YarnCancellationToken)
static func fade_alpha_async(target: CanvasItem, from_alpha: float, to_alpha: float, duration: float, token: YarnCancellationToken = null) -> voidParameters
targetCanvasItemfrom_alphafloatto_alphafloatdurationfloat
#fade_alpha(CanvasItem, float, float, float, int, int)
static func fade_alpha(target: CanvasItem, from_alpha: float, to_alpha: float, duration: float = 0.25, trans_type: int = 0, ease_type: int = 2) -> SignalParameters
targetCanvasItemfrom_alphafloatto_alphafloatdurationfloattrans_typeintease_typeint
Returns Signal
#fade_container(Control, float, float, float)
static func fade_container(container: Control, from_alpha: float, to_alpha: float, duration: float = 0.25) -> SignalParameters
containerControlfrom_alphafloatto_alphafloatdurationfloat
Returns Signal
#fade_in(CanvasItem, float, int, int)
static func fade_in(target: CanvasItem, duration: float = 0.25, trans_type: int = 0, ease_type: int = 2) -> SignalParameters
targetCanvasItemdurationfloattrans_typeintease_typeint
Returns Signal
#fade_out(CanvasItem, float, int, int)
static func fade_out(target: CanvasItem, duration: float = 0.25, trans_type: int = 0, ease_type: int = 2) -> SignalParameters
targetCanvasItemdurationfloattrans_typeintease_typeint
Returns Signal
#punch_scale(Control, float, float)
static func punch_scale(target: Control, punch_scale: float = 1.2, duration: float = 0.1) -> SignalParameters
targetControlpunch_scalefloatdurationfloat
Returns Signal
#shake(Control, float, float, float)
static func shake(target: Control, intensity: float = 5.0, duration: float = 0.3, frequency: float = 30.0) -> SignalParameters
targetControlintensityfloatdurationfloatfrequencyfloat
Returns Signal
#typewriter_with_line(RichTextLabel, YarnLine, float, YarnPauseEventProcessor, YarnCancellationToken)
typewriter with pause support from markup attributes.
static func typewriter_with_line(label: RichTextLabel, line: YarnLine, characters_per_second: float, pause_handler: YarnPauseEventProcessor = null, token: YarnCancellationToken = null) -> SignalParameters
labelRichTextLabellineYarnLinecharacters_per_secondfloatpause_handlerYarnPauseEventProcessor
Returns Signal
#typewriter_words(RichTextLabel, String, float, YarnCancellationToken)
static func typewriter_words(label: RichTextLabel, text: String, words_per_second: float, token: YarnCancellationToken = null) -> SignalParameters
labelRichTextLabeltextStringwords_per_secondfloat
Returns Signal
#typewriter(RichTextLabel, String, float, YarnCancellationToken)
typewriter effect - reveals text character by character. for pause markup support, use typewriter_with_line() with a YarnPauseEventProcessor.
static func typewriter(label: RichTextLabel, text: String, characters_per_second: float, token: YarnCancellationToken = null) -> SignalParameters
labelRichTextLabeltextStringcharacters_per_secondfloat
Returns Signal
Generated from Yarn Spinner for Godot GDScript 3.3.