Interface IEventSettingsData
Contains data associated with a specific IEventSettings.
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IEventSettingsData : IEntityData, ISavedDataProvider, IDataProperties
ClaimInContentId
Declaration
string ClaimInContentId { get; }Property Value
| Type | Description |
|---|---|
| String |
EndTime
The UTC time when this event will end/ended.
Declaration
DateTime EndTime { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
EventContentId
Returns the Id of the IEventContentData that this is associated with.
Declaration
string EventContentId { get; }Property Value
| Type | Description |
|---|---|
| String |
MilestoneRewards
Returns a mapping of IMilestone reward ids to reward ids that exist in the IContent where claiming rewards takes place.
Declaration
MilestoneRewardPair[] MilestoneRewards { get; }Property Value
| Type | Description |
|---|---|
| MilestoneRewardPair[] |
PartitionSize
The amount of players to segment into groups. This is used for Event Leaderboards and rank rewards.
Declaration
int PartitionSize { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Phases
Events are made up of one or more phases. Each phase can have different behaviour.
Declaration
PhaseList Phases { get; }Property Value
| Type | Description |
|---|---|
| PhaseList |
RankRewardDataIds
A list of IRewardData ids. The indexes of RankRewards are paired to the indexes of this field to determine what reward is granted.
Declaration
string[] RankRewardDataIds { get; }Property Value
| Type | Description |
|---|---|
| String[] |
RankRewards
A collection of rank based rewards that can be used for rewarded event leaderboards.
Declaration
List<EventPlayerReward> RankRewards { get; }Property Value
| Type | Description |
|---|---|
| List<EventPlayerReward> |
ScoreRewards
A collection of event progress and reward thresholds.
Declaration
List<EventPlayerReward> ScoreRewards { get; }Property Value
| Type | Description |
|---|---|
| List<EventPlayerReward> |
StartTime
The UTC time that this event started.
Declaration
DateTime StartTime { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
StoreListings
TODO: This will change based on our IAP implementation. Associated store listings for this Event.
Declaration
List<StoreRef> StoreListings { get; }Property Value
| Type | Description |
|---|---|
| List<StoreRef> |
Methods
GetMappedRewardId(String)
Returns a reward id that exists in the IContent where claiming rewards takes place based on the
Declaration
string GetMappedRewardId(string milestoneId)Parameters
| Type | Name | Description |
|---|---|---|
| String | milestoneId |
Returns
| Type | Description |
|---|---|
| String |
UpdatePhaseDuration(Int32, Int32)
Used to directly affect the length of an event phase in data.
Declaration
void UpdatePhaseDuration(int phaseIndex, int newDurationMinutes)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | phaseIndex | Index of the phase in the phases array. |
| Int32 | newDurationMinutes | New duration for the phase. |
UpdateStartTime(String)
Updates the start of the event to the provided string parsed from DateTime.
Declaration
void UpdateStartTime(string startTime)Parameters
| Type | Name | Description |
|---|---|---|
| String | startTime |