Interface IEventSettingsSavedData
ISavedData for IEventSettings.
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IEventSettingsSavedData : ICloudSavedData, ISavedDataProperties
AreRankRewardsClaimed
Returns true if the rank rewards for this event have been claimed.
Declaration
bool AreRankRewardsClaimed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
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
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 |
SetRankRewardsClaimed()
Sets AreRankRewardsClaimed to true.
Declaration
void SetRankRewardsClaimed()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 |