Class Clock
A clock is an alarm that that executes a task with the same symbol name.
Clock must be started and stopped by quest actions.
Clock runs down in game-time (default is 12x real-time).
This also means timer is paused when game is paused.
Assembly: Assembly-CSharp.dll
Syntax
public class Clock : QuestResource, IDisposable
Constructors
|
Improve this Doc
View Source
Clock(Quest)
Declaration
public Clock(Quest parentQuest)
Parameters
Type |
Name |
Description |
Quest |
parentQuest |
Parent quest.
|
|
Improve this Doc
View Source
Clock(Quest, String)
Construct a clock from QBN input.
Declaration
public Clock(Quest parentQuest, string line)
Parameters
Type |
Name |
Description |
Quest |
parentQuest |
Parent quest.
|
String |
line |
Clock definition line from QBN.
|
Properties
|
Improve this Doc
View Source
Enabled
Declaration
public bool Enabled { get; set; }
Property Value
|
Improve this Doc
View Source
Finished
Declaration
public bool Finished { get; }
Property Value
|
Improve this Doc
View Source
Flag
Declaration
public int Flag { get; set; }
Property Value
|
Improve this Doc
View Source
MaxRange
Declaration
public int MaxRange { get; set; }
Property Value
|
Improve this Doc
View Source
MinRange
Declaration
public int MinRange { get; set; }
Property Value
|
Improve this Doc
View Source
RemainingTimeInSeconds
Declaration
public int RemainingTimeInSeconds { get; }
Property Value
|
Improve this Doc
View Source
StartingTimeInSeconds
Declaration
public int StartingTimeInSeconds { get; }
Property Value
Methods
|
Improve this Doc
View Source
ExpandMacro(MacroTypes, out String)
Declaration
public override bool ExpandMacro(MacroTypes macro, out string textOut)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
GetDaysString(Int32)
Declaration
public string GetDaysString(int timeInSeconds)
Parameters
Type |
Name |
Description |
Int32 |
timeInSeconds |
|
Returns
|
Improve this Doc
View Source
GetSaveData()
Declaration
public override object GetSaveData()
Returns
Overrides
|
Improve this Doc
View Source
GetTimeString(Int32)
Declaration
public string GetTimeString(int timeInSeconds)
Parameters
Type |
Name |
Description |
Int32 |
timeInSeconds |
|
Returns
|
Improve this Doc
View Source
RestoreSaveData(Object)
Declaration
public override void RestoreSaveData(object dataIn)
Parameters
Type |
Name |
Description |
Object |
dataIn |
|
Overrides
|
Improve this Doc
View Source
SetResource(String)
Declaration
public override void SetResource(string line)
Parameters
Type |
Name |
Description |
String |
line |
|
Overrides
|
Improve this Doc
View Source
StartTimer()
Starts timer if not already running or complete.
Declaration
|
Improve this Doc
View Source
StopTimer()
Stops clock from running if not already complete.
Declaration
|
Improve this Doc
View Source
Tick(Quest)
Declaration
public override void Tick(Quest caller)
Parameters
Type |
Name |
Description |
Quest |
caller |
|
Overrides