Interface IEventSettingsSavedData
ISavedData for IEventSettings.
Inherited Members
Namespace: IdleKit.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IEventSettingsSavedData : ISavedData, IInjectable
Properties
areRewardsClaimed
Returns true if the rewards for this event have been claimed.
Declaration
bool areRewardsClaimed { get; }
Property Value
Type | Description |
---|---|
Boolean |
isComplete
Returns true if the associated IEventSettings has been completed.
Declaration
bool isComplete { get; }
Property Value
Type | Description |
---|---|
Boolean |
milestoneCompletionInfo
Returns a list of IMilestone's corresponding MilestoneCompletionInfo. This can be in the future for an uncompleted IMilestone.
Declaration
MilestoneCompletionInfo[] milestoneCompletionInfo { get; }
Property Value
Type | Description |
---|---|
MilestoneCompletionInfo[] |
timeCompletedTimestamp
The time this IEventContent was completed in milliseconds.
Declaration
long timeCompletedTimestamp { get; }
Property Value
Type | Description |
---|---|
Int64 |
timeStartedTimestamp
The time this IEventContent was started in milliseconds.
Declaration
long timeStartedTimestamp { get; }
Property Value
Type | Description |
---|---|
Int64 |
Methods
CompleteMilestone(String, Int64)
Declaration
[Obsolete("Deprecated in version 1.3, use SetMilestoneCompletionTime(string, long, bool) instead.", true)]
void CompleteMilestone(string milestoneId, long timestampInMilliseconds)
Parameters
Type | Name | Description |
---|---|---|
String | milestoneId | |
Int64 | timestampInMilliseconds |
EndEvent()
Sets isComplete to true.
Declaration
void EndEvent()
SetEventEndTime(Int64)
Sets the timeCompletedTimestamp of the IEventContent in milliseconds.
Declaration
void SetEventEndTime(long timestamp)
Parameters
Type | Name | Description |
---|---|---|
Int64 | timestamp |
SetMilestoneCompletionTime(String, Int64, Boolean)
Completes a specific IMilestone id.
Declaration
void SetMilestoneCompletionTime(string milestoneId, long timestampInMilliseconds, bool completed)
Parameters
Type | Name | Description |
---|---|---|
String | milestoneId | The IMilestone id that has been completed |
Int64 | timestampInMilliseconds | The time in milliseconds that the IMilestone was completed |
Boolean | completed | Whether the IMilestone was completed, if it was completed the SetMilestoneCompletionTime(String, Int64, Boolean) can no longer update MilestoneCompletionInfo |
SetRewardsClaimed()
Sets areRewardsClaimed to true.
Declaration
void SetRewardsClaimed()
StartEvent(Int64)
Sets the timestamp that the Event started.
Declaration
void StartEvent(long eventStartTimestamp)
Parameters
Type | Name | Description |
---|---|---|
Int64 | eventStartTimestamp |