DurationTextBindingObject
object type30 methodsavailable in: camelot
Methods
In the emulator: 30 implemented.
| method | what it does | status |
|---|---|---|
Assign | Copies another duration text binding and assigns it to this one.(other: DurationTextBinding) | implemented |
CanFormatText | Returns true if this binding has enough configuration to produce formatted text.(): boolean | implemented |
CanUpdateFontString | Returns true if this binding has enough configuration to update its font string with formatted text.(): boolean | implemented |
ClearTextColorCurve | Clears the text color curve used by this binding.() | implemented |
Copy | Returns a copy of this duration text binding.(): DurationTextBinding | implemented |
Disable | Disables automatic updates for this duration text binding.() | implemented |
Enable | Enables automatic updates for this duration text binding.() | implemented |
GetDuration | Returns the duration object used by this duration text binding.(): LuaDurationObject? | implemented |
GetExpiredText | Returns the text shown when the duration has fully expired.(): string? | implemented |
GetFontString | Returns the font string updated by this duration text binding.(): FontString? | implemented |
GetFormattedText | Returns the text that would currently be assigned to the configured font string.(): string | implemented |
GetFormattedTextColor | Returns the text color that would currently be assigned to the configured font string.(): ColorMixin? | implemented |
GetTextColorCurve | Returns the text color curve used by this binding.(): (LuaColorCurveObject?, DurationTextBindingProperty?) | implemented |
GetTimeModifier | Returns the time modifier used when sampling duration values for this binding.(): DurationTimeModifier | implemented |
GetUpdateInterval | Returns the minimum number of seconds between automatic text updates. A value of zero updates every game tick.(): number | implemented |
GetZeroDurationText | Returns the text shown when the duration is not configured, or represents a zero-duration time span.(): string? | implemented |
HasSecretValues | Returns true if the duration text binding has been configured with any secret values.(): boolean | implemented |
IsEnabled | Returns true if this duration text binding updates its font string automatically.(): boolean | implemented |
SetDuration | Configures the duration object used by this duration text binding.(duration: LuaDurationObject) | implemented |
SetEnabled | Configures whether this duration text binding updates its font string automatically.(enabled: boolean) | implemented |
SetExpiredText | Configures the text shown when the duration has fully expired.(text: string?) | implemented |
SetFontString | Configures the font string updated by this duration text binding.(fontString: FontString) | implemented |
SetFormatter | Configures the text format used by this duration text binding to display the remaining duration using the supplied formatter.(formatter: NumericFormatter) | implemented |
SetTextColorCurve | Configures this duration text binding to adjust fontstring text color by evaluating a duration property through a curve.(curve: LuaColorCurveObject, property: DurationTextBindingProperty) | implemented |
SetTextFormat | Configures the text format used by this duration text binding. The format string may contain '{}' placeholders, each of which is substituted by the corresponding component in the supplied array.(formatString: stringView, components: DurationTextBindingFormatComponent[]) | implemented |
SetTimeModifier | Configures the time modifier used when sampling duration values for this binding.(modifier: DurationTimeModifier) | implemented |
SetToDefaults | Resets this duration text binding to its default state, clearing the configured font string, duration, format, formatter, and fallback text.() | implemented |
SetUpdateInterval | Configures the minimum number of seconds between automatic text updates. A value of zero updates every game tick.(updateInterval: number) | implemented |
SetZeroDurationText | Configures the text shown when the duration is not configured, or represents a zero-duration time span.(text: string?) | implemented |
UpdateFontString | Immediately updates the configured font string from the current duration state.() | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated).