====== VILLAGE_EVENT ======

//Abstract class//\\
**Category**: Asset

Parent class: [[:api:asset | ASSET]]\\
Inherited by [[:dlc:agriculture|{{assets:dlc:agriculture.png?16x16|DLC agriculture}}]][[:api:village_event_harvest_festival | VILLAGE_EVENT_HARVEST_FESTIVAL]]



[[:assets:village_event| List of VILLAGE_EVENT assets]]

===== Properties =====

----

==== NameKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== ParticipantPluralNameKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== NeedListNameKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== NeedListDescriptionKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== Duration ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:time_system | TIME_SYSTEM]]''
  * **Expected**: ''TIME_SYSTEM value''

----

==== PreparationDuration ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:time_system | TIME_SYSTEM]]''
  * **Expected**: ''TIME_SYSTEM value''

----

==== DataVillagersNeedDuringVillageEventList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:data_villager_status_need_list_pair | DATA_VILLAGER_STATUS_NEED_LIST_PAIR]]>''
  * **Expected**: ''list of DATA_VILLAGER_STATUS_NEED_LIST_PAIR values''

----

==== AssetVillagerTemporaryOutfitSetupList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:villager_temporary_outfit_setup | VILLAGER_TEMPORARY_OUTFIT_SETUP]]>''
  * **Expected**: ''list of asset IDs''

----

==== AssetVillageEventFreeTimeBehavior ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:behavior_tree | BEHAVIOR_TREE]]''
  * **Expected**: ''asset ID''

----

==== ScoreValuePerFilledNeed ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''10''

----

==== PageIdArray ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#fixed_sized_map|fixed_sized_map]]<[[:api:village_event_state | VILLAGE_EVENT_STATE]], [[:data-types#string|string]]>''
  * **Expected**: ''map with enum values as keys and string values as values''

----

==== AssetEntertainerTroupeList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:asset_entertainer | ASSET_ENTERTAINER]]>''
  * **Expected**: ''list of asset IDs''

----

==== EntertainerTypeButtonList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:entertainment_type | ENTERTAINMENT_TYPE]]>''
  * **Expected**: ''list of enum values''

----

==== EntertainmentTypeWorldGuiIconList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:entertainment_type_icon_pair | ENTERTAINMENT_TYPE_ICON_PAIR]]>''
  * **Expected**: ''list of ENTERTAINMENT_TYPE_ICON_PAIR values''

----

==== FreeTimeLocationPurpose ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:interactive_location_purpose | INTERACTIVE_LOCATION_PURPOSE]]''
  * **Expected**: ''enum value''
  * **Default value**: ''INTERACTIVE_LOCATION_PURPOSE.FREE_TIME''

----

==== AssetVillageEventTierList ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#list|list]]<[[:api:village_event_tier | VILLAGE_EVENT_TIER]]>''
  * **Expected**: ''list of asset IDs''

----

==== IconTier0 ====
//[[:annotations#serialized|Serialized]]//

Icon when it has not reached a tier yet
  * **Type**: ''[[:api:atlas_cell | ATLAS_CELL]]''
  * **Expected**: ''asset ID''

----

==== TrackerDaysBeforeDelete ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''0''

----

==== AssetQuest ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:quest | QUEST]]''
  * **Expected**: ''asset ID''

----

==== MaximumGuestInvitationTicket ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''3''

----

==== AssetDefaultVillageEventCompletedOutcomePanel ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:outcome_panel_data | OUTCOME_PANEL_DATA]]''
  * **Expected**: ''asset ID''

----

==== DefaultRewardsTitleKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== VillageEventProgressionTitleKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== VillageEventProgressionDescriptionKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== StateIcons ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#fixed_sized_map|fixed_sized_map]]<[[:api:village_event_state | VILLAGE_EVENT_STATE]], [[:api:atlas_cell | ATLAS_CELL]]>''
  * **Expected**: ''map with enum values as keys and asset IDs as values''

----

==== AssetGuestInvitationPreviewList ====
//[[:annotations#serialized|Serialized]]//

Guest invitations to preview in progression screen, these will need to be unlocked from a game action to be invited
  * **Type**: ''[[:data-types#list|list]]<[[:api:village_event_guest_invitation | VILLAGE_EVENT_GUEST_INVITATION]]>''
  * **Expected**: ''list of asset IDs''

----

==== TimeOffsetToEstimateGuestNeedFillingTime ====
//[[:annotations#serialized|Serialized]]//

This offset will be added to the minimum time required to fill a need + the fillness duration to estimate how many need instance a guest can fill during the village event.  \\  if an entertainment need takes minimum 30 seconds stay at the interactive location and has a 100 seconds fillness duration and the offset is set to 20 seconds, we will evaluate 150 seconds for a need filling  \\ 
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''30.0f''