[This is preliminary documentation and is subject to change.]
Provides a way to create and manage publicly-announced countdowns.
Long timers announce once an hour (e.g. "7h left").
During the last hour, timer announces more often: every 10 minutes, then every minute,
then every 10 seconds, and finally every second - until the timer is up.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.1 (0.6.3.1)
Syntax
| C# |
public sealed class ChatTimer
Members
| All Members | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| Abort()()()() | Stops this timer, and removes it from the list of timers. | |
| Aborted | Whether this timer has been aborted. | |
| Duration | The amount of time between when this timer was started and when it will end. | |
| EndTime | Date/Time (UTC) at which this timer will end. | |
| Equals(Object) | (Inherited from Object.) | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| FindTimerById(Int32) | Searches for a timer by its numeric ID. | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| ID | Timer's unique numeric ID. | |
| IsRunning | Whether or not the timer is currently running. | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Message | Message to be displayed once the timer reaches zero. | |
| MinDuration | Minimum allowed timer duration (one second). | |
| Start(TimeSpan, String, String) | Starts this timer with the specified duration, and end message. | |
| Started | Occurs after a ChatTimer was added. | |
| StartedBy | Name of the player (or entity) who started this timer | |
| StartTime | Date/Time (UTC) at which this timer was started. | |
| Stopped | Occurs after a ChatTimer has expired or was aborted. | |
| TimeLeft | The amount of time remaining in this timer. | |
| TimerList | Returns a list of all active timers. | |
| ToString()()()() | (Inherited from Object.) |