DurationObject
object type31 methodsavailable in: camelot
Methods
In the emulator: 31 implemented.
| method | what it does | status |
|---|---|---|
Assign | Copies another duration object and assigns it to this one. · warcraft.wiki.gg ↗(other: LuaDurationObject) | implemented |
Copy | Returns a copy of this duration object. · warcraft.wiki.gg ↗(): LuaDurationObject | implemented |
EvaluateElapsedDuration | Calculates the elapsed duration in seconds and evaluates it against a supplied curve. · warcraft.wiki.gg ↗(curve: LuaCurveObjectBase, modifier: DurationTimeModifier): LuaCurveEvaluatedResult | implemented |
EvaluateElapsedPercent | Calculates the elapsed duration as a percentage value and evaluates it against a supplied curve. · warcraft.wiki.gg ↗(curve: LuaCurveObjectBase, modifier: DurationTimeModifier): LuaCurveEvaluatedResult | implemented |
EvaluateRemainingDuration | Calculates the remaining duration in seconds and evaluates it against a supplied curve. · warcraft.wiki.gg ↗(curve: LuaCurveObjectBase, modifier: DurationTimeModifier): LuaCurveEvaluatedResult | implemented |
EvaluateRemainingPercent | Calculates the remaining duration as a percentage value and evaluates it against a supplied curve. · warcraft.wiki.gg ↗(curve: LuaCurveObjectBase, modifier: DurationTimeModifier): LuaCurveEvaluatedResult | implemented |
EvaluateTotalDuration | Calculates the total duration in seconds and evaluates it against a supplied curve. · warcraft.wiki.gg ↗(curve: LuaCurveObjectBase, modifier: DurationTimeModifier): LuaCurveEvaluatedResult | implemented |
FormatElapsedDuration | Formats the elapsed duration of this object to a string. · warcraft.wiki.gg ↗(formatter: NumericFormatter, modifier: DurationTimeModifier): string | implemented |
FormatRemainingDuration | Formats the remaining duration of this object to a string. · warcraft.wiki.gg ↗(formatter: NumericFormatter, modifier: DurationTimeModifier): string | implemented |
FormatTotalDuration | Formats the total duration of this object to a string. · warcraft.wiki.gg ↗(formatter: NumericFormatter, modifier: DurationTimeModifier): string | implemented |
GetClock | Returns the clock source used by this object. · warcraft.wiki.gg ↗(): LuaDurationClock? | implemented |
GetClockTime | Returns the current time of the clock source used by this object. · warcraft.wiki.gg ↗(): FrameTime | implemented |
GetElapsedDuration | Calculates the elapsed duration of the stored time span. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): Seconds | implemented |
GetElapsedPercent | Calculates the elapsed duration as a percentage value. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): number | implemented |
GetEndTime | Calculates the end time of the stored time span. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): FrameTime | implemented |
GetModRate | Returns the divisor used to convert a duration from real time to base time. · warcraft.wiki.gg ↗(): number | implemented |
GetRemainingDuration | Calculates the remaining duration of the stored time span. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): Seconds | implemented |
GetRemainingPercent | Calculates the remaining duration as a percentage value. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): number | implemented |
GetStartTime | Calculates the start time of the stored time span. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): FrameTime | implemented |
GetTotalDuration | Calculates the total duration of the stored time span. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): Seconds | implemented |
HasExpired | Returns true once the duration has reached its end time. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): boolean | implemented |
HasSecretValues | Returns true if the duration has been configured with any secret values. · warcraft.wiki.gg ↗(): boolean | implemented |
HasStarted | Returns true once the duration has reached its start time. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): boolean | implemented |
IsActive | Returns true while the duration is at or after its start time and before its end time. · warcraft.wiki.gg ↗(modifier: DurationTimeModifier): boolean | implemented |
IsZero | Returns true if the duration object is measuring a zero duration time span. · warcraft.wiki.gg ↗(): boolean | implemented |
Reset | Resets the duration object to represent a zero duration time span. · warcraft.wiki.gg ↗() | implemented |
SetClock | Configures the clock source used by this object. · warcraft.wiki.gg ↗(clock: LuaDurationClock?) | implemented |
SetTimeFromEnd | Configures the duration object to represent an end time and a duration. · warcraft.wiki.gg ↗(endTime: FrameTime, duration: Seconds, modRate: number) | implemented |
SetTimeFromStart | Configures the duration object to represent a start time and a duration. · warcraft.wiki.gg ↗(startTime: FrameTime, duration: Seconds, modRate: number) | implemented |
SetTimeSpan | Configures the duration object to represent a fixed start and end time span. If the end time is earlier than the start time, the duration will clamp to zero. · warcraft.wiki.gg ↗(startTime: FrameTime, endTime: FrameTime) | implemented |
SetToDefaults | Resets all state on the duration, and clears the secret values flag. · warcraft.wiki.gg ↗() | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗.