====== Changelog ======

===== API Changes =====
==== Asset Classes ====
=== Added ===
  * ''[[api:atlas_cell | ATLAS_CELL]]''
  * ''[[api:building_function_training_site | BUILDING_FUNCTION_TRAINING_SITE]]''
  * ''[[api:desirability_modifier | DESIRABILITY_MODIFIER]]''
=== Other changes ===
  * ''[[api:balancing | BALANCING]]''
    * Removed properties
      * ''NameList''
  * ''[[api:building | BUILDING]]''
    * Added properties
      * ''[[api:BUILDING#assetminiaturebuildingpart | AssetMiniatureBuildingPart]]''
  * ''[[api:building_function | BUILDING_FUNCTION]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION#description | Description]]''
  * ''[[api:building_function_bailiff_office | BUILDING_FUNCTION_BAILIFF_OFFICE]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_BAILIFF_OFFICE#bailiffavailablenotificationdata | BailiffAvailableNotificationData]]''
  * ''[[api:building_function_house | BUILDING_FUNCTION_HOUSE]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_HOUSE#description | Description]]''
  * ''[[api:building_function_point_of_interest | BUILDING_FUNCTION_POINT_OF_INTEREST]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_POINT_OF_INTEREST#visitornotification | VisitorNotification]]''
  * ''[[api:building_function_warehouse | BUILDING_FUNCTION_WAREHOUSE]]''
    * Changed properties type
      * ''[[api:BUILDING_FUNCTION_WAREHOUSE#allowedresourcetypelist | AllowedResourceTypeList]]''
  * ''[[api:building_function_workplace | BUILDING_FUNCTION_WORKPLACE]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_WORKPLACE#ispausable | IsPausable]]''
      * ''[[api:BUILDING_FUNCTION_WORKPLACE#randomworkstationreservation | RandomWorkstationReservation]]''
      * ''[[api:BUILDING_FUNCTION_WORKPLACE#assetnozonenotification | AssetNoZoneNotification]]''
      * ''[[api:BUILDING_FUNCTION_WORKPLACE#assetnoresourceinzonenotification | AssetNoResourceInZoneNotification]]''
  * ''[[api:desirability | DESIRABILITY]]''
    * Added properties
      * ''[[api:DESIRABILITY#description | Description]]''
      * ''[[api:DESIRABILITY#buttoniconlist | ButtonIconList]]''
  * ''[[api:estate | ESTATE]]''
    * Added properties
      * ''[[api:ESTATE#headerimage | HeaderImage]]''
    * Renamed properties
      * ''Icon -> [[api:ESTATE#influenceicon | InfluenceIcon]]''
    * Changed properties type
      * ''[[api:ESTATE#influenceicon | InfluenceIcon]]''
      * ''[[api:ESTATE#splendoricon | SplendorIcon]]''
  * ''[[api:game_rule_masterpiece | GAME_RULE_MASTERPIECE]]''
    * Removed properties
      * ''AchievementGiverMasterpiece''
  * ''[[api:game_rule_mineral | GAME_RULE_MINERAL]]''
    * Removed properties
      * ''GenericMineralPrefab''
  * ''[[api:game_rule_status_promotion | GAME_RULE_STATUS_PROMOTION]]''
    * Added properties
      * ''[[api:GAME_RULE_STATUS_PROMOTION#villagerprofileorderinglist | VillagerProfileOrderingList]]''
      * ''[[api:GAME_RULE_STATUS_PROMOTION#notificationdata | NotificationData]]''
      * ''[[api:GAME_RULE_STATUS_PROMOTION#promotiondurationindays | PromotionDurationInDays]]''
  * ''[[api:happiness_factor | HAPPINESS_FACTOR]]''
    * Added properties
      * ''[[api:HAPPINESS_FACTOR#description | Description]]''
      * ''[[api:HAPPINESS_FACTOR#icon | Icon]]''
  * ''[[api:help | HELP]]''
    * Added properties
      * ''[[api:HELP#helpcategorylist | HelpCategoryList]]''
    * Removed properties
      * ''HelpItemList''
      * ''Introduction''
  * ''[[api:job | JOB]]''
    * Removed properties
      * ''AssetNoZoneNotification''
      * ''AssetNoResourceInZoneNotification''
      * ''AssetNoTreeChoiceNotification''
  * ''[[api:masterpiece | MASTERPIECE]]''
    * Added properties
      * ''[[api:MASTERPIECE#description | Description]]''
      * ''[[api:MASTERPIECE#assetminiaturebuildingpart | AssetMiniatureBuildingPart]]''
  * ''[[api:material | MATERIAL]]''
    * Added properties
      * ''[[api:MATERIAL#rendermode | RenderMode]]''
    * Removed properties
      * ''HasTransparency''
      * ''IsLighted''
  * ''[[api:military_campaign | MILITARY_CAMPAIGN]]''
    * Added properties
      * ''[[api:MILITARY_CAMPAIGN#missiondifficultylist | MissionDifficultyList]]''
      * ''[[api:MILITARY_CAMPAIGN#assetnotification | AssetNotification]]''
    * Removed properties
      * ''MissionList''
  * ''[[api:notification | NOTIFICATION]]''
    * Added properties
      * ''[[api:NOTIFICATION#description | Description]]''
      * ''[[api:NOTIFICATION#icon | Icon]]''
      * ''[[api:NOTIFICATION#isunscaleddeltatime | IsUnscaledDeltatime]]''
      * ''[[api:NOTIFICATION#iscycling | IsCycling]]''
      * ''[[api:NOTIFICATION#delaybetweencycling | DelayBetweenCycling]]''
      * ''[[api:NOTIFICATION#clickinstructiontext | ClickInstructionText]]''
    * Removed properties
      * ''IsUnique''
    * Renamed properties
      * ''TooltipText -> [[api:NOTIFICATION#title | Title]]''
  * ''[[api:plantable | PLANTABLE]]''
    * Added properties
      * ''[[api:PLANTABLE#icon | Icon]]''
  * ''[[api:resource | RESOURCE]]''
    * Changed properties type
      * ''[[api:RESOURCE#icon | Icon]]''
  * ''[[api:trading_village | TRADING_VILLAGE]]''
    * Added properties
      * ''[[api:TRADING_VILLAGE#description | Description]]''
      * ''[[api:TRADING_VILLAGE#heraldry | Heraldry]]''
  * ''[[api:unlockable | UNLOCKABLE]]''
    * Added properties
      * ''[[api:UNLOCKABLE#unlockableimage | UnlockableImage]]''
  * ''[[api:unlockable_building | UNLOCKABLE_BUILDING]]''
    * Renamed properties
      * ''RelatedProp -> [[api:UNLOCKABLE_BUILDING#assetbuilding | AssetBuilding]]''
  * ''[[api:villager_need_type | VILLAGER_NEED_TYPE]]''
    * Added properties
      * ''[[api:VILLAGER_NEED_TYPE#needtypedescription | NeedTypeDescription]]''
    * Changed properties type
      * ''[[api:VILLAGER_NEED_TYPE#resourcetypeicon | ResourceTypeIcon]]''
  * ''[[api:villager_profile | VILLAGER_PROFILE]]''
    * Added properties
      * ''[[api:VILLAGER_PROFILE#profilenameplural | ProfileNamePlural]]''
  * ''[[api:villager_status | VILLAGER_STATUS]]''
    * Added properties
      * ''[[api:VILLAGER_STATUS#statusdescription | StatusDescription]]''
      * ''[[api:VILLAGER_STATUS#statusicon | StatusIcon]]''
  * ''[[api:wall_config | WALL_CONFIG]]''
    * Added properties
      * ''[[api:WALL_CONFIG#buildingtype | BuildingType]]''
  * ''[[api:zone | ZONE]]''
    * Added properties
      * ''[[api:ZONE#icon | Icon]]''
      * ''[[api:ZONE#hovericon | HoverIcon]]''
      * ''[[api:ZONE#selectionicon | SelectionIcon]]''

----

==== Data Classes ====
=== Added ===
  * ''[[api:building_function_warehouse_allowed_resource_type_info | BUILDING_FUNCTION_WAREHOUSE_ALLOWED_RESOURCE_TYPE_INFO]]''
  * ''[[api:building_information | BUILDING_INFORMATION]]''
  * ''[[api:building_issue_list_entry | BUILDING_ISSUE_LIST_ENTRY]]''
  * ''[[api:building_miniature_config | BUILDING_MINIATURE_CONFIG]]''
  * ''[[api:game_rule_modifier_descriptor | GAME_RULE_MODIFIER_DESCRIPTOR]]''
  * ''[[api:game_rule_modifier_descriptor_event | GAME_RULE_MODIFIER_DESCRIPTOR_EVENT]]''
  * ''[[api:game_rule_modifier_descriptor_house_move | GAME_RULE_MODIFIER_DESCRIPTOR_HOUSE_MOVE]]''
  * ''[[api:game_rule_modifier_descriptor_job_status | GAME_RULE_MODIFIER_DESCRIPTOR_JOB_STATUS]]''
  * ''[[api:game_rule_modifier_descriptor_resource_type | GAME_RULE_MODIFIER_DESCRIPTOR_RESOURCE_TYPE]]''
  * ''[[api:game_rule_modifier_descriptor_status | GAME_RULE_MODIFIER_DESCRIPTOR_STATUS]]''
  * ''[[api:game_rule_modifier_descriptor_string | GAME_RULE_MODIFIER_DESCRIPTOR_STRING]]''
  * ''[[api:game_rule_modifier_descriptor_unlockable | GAME_RULE_MODIFIER_DESCRIPTOR_UNLOCKABLE]]''
  * ''[[api:help_category | HELP_CATEGORY]]''
  * ''[[api:help_instance | HELP_INSTANCE]]''
  * ''[[api:quest_function_survive_bad_weather | QUEST_FUNCTION_SURVIVE_BAD_WEATHER]]''
=== Removed ===
  * ''MANDATE_STUDY_BLUEPRINT''
  * ''MANDATE_PROSPECT_MINERALS''
  * ''DATA_MILITARY_MISSION''
=== Other changes ===
  * ''[[api:action_visit | ACTION_VISIT]]''
    * Added properties
      * ''[[api:ACTION_VISIT#visitorapproachingnotification | VisitorApproachingNotification]]''
  * ''[[api:building_constructor | BUILDING_CONSTRUCTOR]]''
    * Added properties
      * ''[[api:BUILDING_CONSTRUCTOR#miniatureconfig | MiniatureConfig]]''
    * Removed properties
      * ''ClipUnderGroundInPreview''
  * ''[[api:event_action | EVENT_ACTION]]''
    * Added properties
      * ''[[api:EVENT_ACTION#icon | Icon]]''
  * ''[[api:game_rule_modifier_villager_happiness | GAME_RULE_MODIFIER_VILLAGER_HAPPINESS]]''
    * Added properties
      * ''[[api:GAME_RULE_MODIFIER_VILLAGER_HAPPINESS#ruledescriptor | RuleDescriptor]]''
  * ''[[api:mandate | MANDATE]]''
    * Added functions
      * ''[[api:MANDATE#initialize | initialize]]''
      * ''[[api:MANDATE#cancelmandate | cancelMandate]]''
      * ''[[api:MANDATE#completemandate | completeMandate]]''
      * ''[[api:MANDATE#getcurrentstatetext | getCurrentStateText]]''
  * ''[[api:particle_emitter_shape_sphere | PARTICLE_EMITTER_SHAPE_SPHERE]]''
    * Added properties
      * ''[[api:PARTICLE_EMITTER_SHAPE_SPHERE#radiusrange | RadiusRange]]''
      * ''[[api:PARTICLE_EMITTER_SHAPE_SPHERE#coneangle | ConeAngle]]''
    * Removed properties
      * ''Radius''
  * ''[[api:quest_function_immigration | QUEST_FUNCTION_IMMIGRATION]]''
    * Removed properties
      * ''AssetEventBadWeather''
      * ''AssetEventBadWeatherEnd''
  * ''[[api:quest_reward_random_resource | QUEST_REWARD_RANDOM_RESOURCE]]''
    * Added properties
      * ''[[api:QUEST_REWARD_RANDOM_RESOURCE#budgetcategory | BudgetCategory]]''
  * ''[[api:quest_reward_resources | QUEST_REWARD_RESOURCES]]''
    * Added properties
      * ''[[api:QUEST_REWARD_RESOURCES#budgetcategory | BudgetCategory]]''

----

==== Engine Core ====
=== Other changes ===
  * ''[[api:component | COMPONENT]]''
    * Added functions
      * ''[[api:COMPONENT#onfinalize | onFinalize]]''
      * ''[[api:COMPONENT#ondestroy | onDestroy]]''
      * ''[[api:COMPONENT#getcomponenttype | getComponentType]]''
    * Removed functions
      * ''finalize''
      * ''destroy''
  * ''[[api:level | LEVEL]]''
    * Changed functions
      * ''[[api:LEVEL#find | find]]''

----

==== Component Classes ====
=== Added ===
  * ''[[api:comp_workplace_forester | COMP_WORKPLACE_FORESTER]]''
  * ''[[api:comp_workplace_kitchen | COMP_WORKPLACE_KITCHEN]]''
  * ''[[api:comp_workplace_tax_office | COMP_WORKPLACE_TAX_OFFICE]]''
=== Removed ===
  * ''COMP_ON_EVENT_ANIMATION_CONTROLLER''
=== Other changes ===
  * ''[[api:comp_building | COMP_BUILDING]]''
    * Added events
      * ''[[api:COMP_BUILDING#on_preview_upkeep_cost_changed | ON_PREVIEW_UPKEEP_COST_CHANGED]]''
      * ''[[api:COMP_BUILDING#on_building_batch_change_in_frame | ON_BUILDING_BATCH_CHANGE_IN_FRAME]]''
      * ''[[api:COMP_BUILDING#on_splendor_update | ON_SPLENDOR_UPDATE]]''
  * ''[[api:comp_building_manager | COMP_BUILDING_MANAGER]]''
    * Added functions
      * ''[[api:COMP_BUILDING_MANAGER#unlockbuildinglistbyunlockname | unlockBuildingListByUnlockName]]''
      * ''[[api:COMP_BUILDING_MANAGER#getunlockbuildinglistbyunlockname | getUnlockBuildingListByUnlockName]]''
      * ''[[api:COMP_BUILDING_MANAGER#unlockbuilding | unlockBuilding]]''
      * ''[[api:COMP_BUILDING_MANAGER#lockbuilding | lockBuilding]]''
      * ''[[api:COMP_BUILDING_MANAGER#canassignbuildingfunction | canAssignBuildingFunction]]''
      * ''[[api:COMP_BUILDING_MANAGER#getassignedbuildingfunctioncount | getAssignedBuildingFunctionCount]]''
      * ''[[api:COMP_BUILDING_MANAGER#unlockwall | unlockWall]]''
  * ''[[api:comp_building_part | COMP_BUILDING_PART]]''
    * Added functions
      * ''[[api:COMP_BUILDING_PART#getispreview | getIsPreview]]''
      * ''[[api:COMP_BUILDING_PART#getisbuilt | getIsBuilt]]''
      * ''[[api:COMP_BUILDING_PART#getisplaced | getIsPlaced]]''
      * ''[[api:COMP_BUILDING_PART#isvisiblewhenbuilt | isVisibleWhenBuilt]]''
      * ''[[api:COMP_BUILDING_PART#isdisplayable | isDisplayable]]''
      * ''[[api:COMP_BUILDING_PART#ismonumentcore | isMonumentCore]]''
  * ''[[api:comp_villager | COMP_VILLAGER]]''
    * Added functions
      * ''[[api:COMP_VILLAGER#finddisplayjobinstance | findDisplayJobInstance]]''
  * ''[[api:comp_workplace | COMP_WORKPLACE]]''
    * Added events
      * ''[[api:COMP_WORKPLACE#on_workplace_status_update | ON_WORKPLACE_STATUS_UPDATE]]''

----

==== Enumerations ====
=== Added ===
  * ''[[api:material_render_mode | MATERIAL_RENDER_MODE]]''
  * ''[[api:image_asset_type | IMAGE_ASSET_TYPE]]''
  * ''[[api:button_state | BUTTON_STATE]]''
  * ''[[api:terrain_static_layer_zone_type | TERRAIN_STATIC_LAYER_ZONE_TYPE]]''
  * ''[[api:agent_issue | AGENT_ISSUE]]''
  * ''[[api:building_status | BUILDING_STATUS]]''
  * ''[[api:workplace_status | WORKPLACE_STATUS]]''
  * ''[[api:budget_category | BUDGET_CATEGORY]]''
  * ''[[api:ruler_title | RULER_TITLE]]''
  * ''[[api:soldier_status | SOLDIER_STATUS]]''
=== Removed ===
  * ''DEBUG_GLOBAL_VARIABLE''
=== Renamed ===
  * ''SOLDIER_STATE -> [[api:soldier_training_state | SOLDIER_TRAINING_STATE]]''
=== Other changes ===
  * ''[[api:agent_animation | AGENT_ANIMATION]]''
    * Added values
      * ''WALK_MONK''
      * ''HAND_ATTACK''
      * ''SPEAR_ATTACK''
      * ''WALK_SPEAR''
      * ''SWORD_ATTACK_01''
      * ''WALK_SWORD''
      * ''WALK_LUMBER''
      * ''WALK_MINER''
      * ''WALK_BAKER''
      * ''WEAPONSMITH''
      * ''HOPCARING''
      * ''BEEKEEPER''
      * ''BEEKEEPER2''
      * ''BREWING''
      * ''BUILDER_PLANNING''
      * ''BUILDER_PLANNING_2''
      * ''BUILDER_PLANNING_3''
      * ''BUILDER_SCULPTING''
      * ''SAW''
      * ''GOLDSMELTER_MELTING''
      * ''GOLDSMELTER_SHOVELING''
      * ''GOLDSMELTER_OVEN''
      * ''GLASSMELTER_MELTING''
      * ''GLASSMELTER_SHOVELING''
      * ''GLASSMELTER_OVEN''
      * ''IRONSMELTING''
      * ''JEWELER_PLANNING''
      * ''MIXING''
      * ''PROSPECTING''
      * ''QUARRY_MINING_BOT''
      * ''QUARRY_MINING_MID''
      * ''QUARRY_MINING_TOP''
      * ''BEAM''
      * ''RENDER''
      * ''STAINGLASS_CUTTING''
      * ''TAILORING''
      * ''WEAVER''
      * ''WINDMILL''
      * ''BOTTLE_FILLING''
      * ''WINEMAKING''
  * ''[[api:building_type | BUILDING_TYPE]]''
    * Added values
      * ''WALL''
      * ''RESOURCE_PRODUCTION''
      * ''FOOD_PRODUCTION''
      * ''GOODS_PRODUCTION''
      * ''LOGISTICS''
      * ''SERVICE''
      * ''ADMINISTRATION''
      * ''MODS''
      * ''TRANSPORTATION''
  * ''[[api:notification_type | NOTIFICATION_TYPE]]''
    * Added values
      * ''GENERAL''
      * ''VILLAGERS''
      * ''VILLAGERS_NO_LOGS''
      * ''RESOURCES''
      * ''BUILDING''
  * ''[[api:resource_type | RESOURCE_TYPE]]''
    * Added values
      * ''WATER''
    * Removed values
      * ''PRIMARY_NEED''

----

==== BUILDING ====
=== Added ===
  * ''[[assets:building | BUILDING_HOUSE]]''
=== Removed ===
  * ''MONUMENT_CUSTOM_FOUNTAIN''

----

==== JOB ====
=== Removed ===
  * ''SCHOLAR''

----

==== PREFAB ====
=== Added ===
  * ''[[assets:prefab | PREFAB_GAME_CAMERA]]''