Foundation - Modding Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Changelog Preview Patch 1.6.6.0707 ======

===== API Changes =====
==== Asset Classes ====
=== Added ===
  * ''[[api:building_function_point_of_interest | BUILDING_FUNCTION_POINT_OF_INTEREST]]''
  * ''[[api:game_rule_masterpiece | GAME_RULE_MASTERPIECE]]''
  * ''[[api:masterpiece | MASTERPIECE]]''
  * ''[[api:masterpiece_list | MASTERPIECE_LIST]]''
=== Other changes ===
  * ''[[api:agent_workstation_setup | AGENT_WORKSTATION_SETUP]]''
    * Added properties
      * ''[[api:AGENT_WORKSTATION_SETUP#locationtypelist | LocationTypeList]]''
  * ''[[api:building_function_farm | BUILDING_FUNCTION_FARM]]''
    * Changed properties type
      * ''[[api:BUILDING_FUNCTION_FARM#harvestsetup | HarvestSetup]]''
      * ''[[api:BUILDING_FUNCTION_FARM#sowingsetup | SowingSetup]]''
  * ''[[api:building_function_quarry | BUILDING_FUNCTION_QUARRY]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_QUARRY#randomresourcetospawn | RandomResourceToSpawn]]''
      * ''[[api:BUILDING_FUNCTION_QUARRY#spawnpercentage | SpawnPercentage]]''
  * ''[[api:building_part | BUILDING_PART]]''
    * Added properties
      * ''[[api:BUILDING_PART#ismonumentcore | IsMonumentCore]]''
      * ''[[api:BUILDING_PART#ismovablewhenbuilt | IsMovableWhenBuilt]]''
    * Changed properties type
      * ''[[api:BUILDING_PART#category | Category]]''
  * ''[[api:event | EVENT]]''
    * Added properties
      * ''[[api:EVENT#actionlist | ActionList]]''
    * Removed properties
      * ''AudioEvent''
      * ''HasAudio''
      * ''PanelVisual''
      * ''ChoiceList''
      * ''EnvoyProfile''
  * ''[[api:game_rule_mineral | GAME_RULE_MINERAL]]''
    * Added properties
      * ''[[api:GAME_RULE_MINERAL#debugmineraltoassign | DebugMineralToAssign]]''
  * ''[[api:military_campaign | MILITARY_CAMPAIGN]]''
    * Added properties
      * ''[[api:MILITARY_CAMPAIGN#panelvisual | PanelVisual]]''

----

==== Data Classes ====
=== Added ===
  * ''[[api:action_show_narrative_panel | ACTION_SHOW_NARRATIVE_PANEL]]''
  * ''[[api:action_visit | ACTION_VISIT]]''
  * ''[[api:agent_profile_function_visitor | AGENT_PROFILE_FUNCTION_VISITOR]]''
  * ''[[api:building_zone_entry | BUILDING_ZONE_ENTRY]]''
  * ''[[api:data_narrative_panel | DATA_NARRATIVE_PANEL]]''
  * ''[[api:event_action_add_trade_route | EVENT_ACTION_ADD_TRADE_ROUTE]]''
  * ''[[api:event_action_immigrate | EVENT_ACTION_IMMIGRATE]]''
  * ''[[api:event_action_random_action | EVENT_ACTION_RANDOM_ACTION]]''
  * ''[[api:event_action_remove_trade_route | EVENT_ACTION_REMOVE_TRADE_ROUTE]]''
  * ''[[api:game_condition_building_inventory | GAME_CONDITION_BUILDING_INVENTORY]]''
  * ''[[api:game_condition_building_part_count | GAME_CONDITION_BUILDING_PART_COUNT]]''
  * ''[[api:game_condition_decorative_part_count | GAME_CONDITION_DECORATIVE_PART_COUNT]]''
  * ''[[api:game_condition_forest_surrounded | GAME_CONDITION_FOREST_SURROUNDED]]''
  * ''[[api:game_condition_influence_amount_reached | GAME_CONDITION_INFLUENCE_AMOUNT_REACHED]]''
  * ''[[api:game_condition_inside_zone | GAME_CONDITION_INSIDE_ZONE]]''
  * ''[[api:game_condition_military_campaign_completed | GAME_CONDITION_MILITARY_CAMPAIGN_COMPLETED]]''
  * ''[[api:game_condition_monthly_trade_revenue | GAME_CONDITION_MONTHLY_TRADE_REVENUE]]''
  * ''[[api:game_condition_multiple_condition | GAME_CONDITION_MULTIPLE_CONDITION]]''
  * ''[[api:game_condition_part_of_building | GAME_CONDITION_PART_OF_BUILDING]]''
  * ''[[api:game_condition_quest_completed | GAME_CONDITION_QUEST_COMPLETED]]''
  * ''[[api:game_condition_splendor_amount_reached | GAME_CONDITION_SPLENDOR_AMOUNT_REACHED]]''
  * ''[[api:game_condition_visit | GAME_CONDITION_VISIT]]''
  * ''[[api:game_condition_wounded_count | GAME_CONDITION_WOUNDED_COUNT]]''
  * ''[[api:game_rule_modifier_apply_action | GAME_RULE_MODIFIER_APPLY_ACTION]]''
  * ''[[api:game_rule_modifier_building_maintenance_cost | GAME_RULE_MODIFIER_BUILDING_MAINTENANCE_COST]]''
  * ''[[api:game_rule_modifier_estate_influence | GAME_RULE_MODIFIER_ESTATE_INFLUENCE]]''
  * ''[[api:game_rule_modifier_immigration_rate | GAME_RULE_MODIFIER_IMMIGRATION_RATE]]''
  * ''[[api:game_rule_modifier_improve_area_desirability | GAME_RULE_MODIFIER_IMPROVE_AREA_DESIRABILITY]]''
  * ''[[api:game_rule_modifier_monument_splendor | GAME_RULE_MODIFIER_MONUMENT_SPLENDOR]]''
  * ''[[api:game_rule_modifier_need_permanently_filled | GAME_RULE_MODIFIER_NEED_PERMANENTLY_FILLED]]''
  * ''[[api:game_rule_modifier_need_type_deplete_rate | GAME_RULE_MODIFIER_NEED_TYPE_DEPLETE_RATE]]''
  * ''[[api:game_rule_modifier_soldier_recovery_speed | GAME_RULE_MODIFIER_SOLDIER_RECOVERY_SPEED]]''
  * ''[[api:quest_function_immigration | QUEST_FUNCTION_IMMIGRATION]]''
=== Removed ===
  * ''BUILDING_CONSTRUCTOR_RANDOM''
=== Other changes ===
  * ''[[api:agent_profile_function | AGENT_PROFILE_FUNCTION]]''
    * Added properties
      * ''[[api:AGENT_PROFILE_FUNCTION#assetstatusquota | AssetStatusQuota]]''
  * ''[[api:agent_profile_function_soldier | AGENT_PROFILE_FUNCTION_SOLDIER]]''
    * Removed properties
      * ''AssetStatusQuota''
  * ''[[api:building_constructor_bridge | BUILDING_CONSTRUCTOR_BRIDGE]]''
    * Added properties
      * ''[[api:BUILDING_CONSTRUCTOR_BRIDGE#minimumheightaboveground | MinimumHeightAboveGround]]''
  * ''[[api:building_zone | BUILDING_ZONE]]''
    * Added properties
      * ''[[api:BUILDING_ZONE#zoneentrylist | ZoneEntryList]]''
    * Removed properties
      * ''GrassClearPolygon''
      * ''NavigablePolygon''
      * ''IsNavigable''
      * ''IsClearingGrass''
  * ''[[api:character_setup | CHARACTER_SETUP]]''
    * Added properties
      * ''[[api:CHARACTER_SETUP#malehatlist | MaleHatList]]''
      * ''[[api:CHARACTER_SETUP#femalehatlist | FemaleHatList]]''
      * ''[[api:CHARACTER_SETUP#malebacklist | MaleBackList]]''
      * ''[[api:CHARACTER_SETUP#femalebacklist | FemaleBackList]]''
      * ''[[api:CHARACTER_SETUP#malefrontlist | MaleFrontList]]''
      * ''[[api:CHARACTER_SETUP#femalefrontlist | FemaleFrontList]]''
      * ''[[api:CHARACTER_SETUP#malebeltlist | MaleBeltList]]''
      * ''[[api:CHARACTER_SETUP#femalebeltlist | FemaleBeltList]]''
    * Removed properties
      * ''MaleBackModel''
      * ''ForceNoMaleBack''
      * ''FemaleBackModel''
      * ''FemaleHatModel''
      * ''ForceNoMaleHat''
      * ''ForceNoFemaleBack''
      * ''MaleHatModel''
      * ''ForceNoFemaleHat''
      * ''MaleBeltModel''
      * ''ForceNoMaleBelt''
      * ''FemaleBeltModel''
      * ''ForceNoFemaleBelt''
      * ''WorkAnimation''
  * ''[[api:event_action | EVENT_ACTION]]''
    * Removed properties
      * ''ShortName''
  * ''[[api:game_condition_villager_status_reached | GAME_CONDITION_VILLAGER_STATUS_REACHED]]''
    * Added properties
      * ''[[api:GAME_CONDITION_VILLAGER_STATUS_REACHED#numberrequired | NumberRequired]]''
  * ''[[api:monument_required_part_pair | MONUMENT_REQUIRED_PART_PAIR]]''
    * Added properties
      * ''[[api:MONUMENT_REQUIRED_PART_PAIR#max | Max]]''
    * Renamed properties
      * ''Quantity -> [[api:MONUMENT_REQUIRED_PART_PAIR#min | Min]]''
    * Changed properties type
      * ''[[api:MONUMENT_REQUIRED_PART_PAIR#category | Category]]''

----

==== Behavior Tree Data Classes ====
=== Other changes ===
  * ''[[api:behavior_tree_data_workstation_setup | BEHAVIOR_TREE_DATA_WORKSTATION_SETUP]]''
    * Changed properties type
      * ''[[api:BEHAVIOR_TREE_DATA_WORKSTATION_SETUP#workstationsetup | WorkstationSetup]]''

----

==== Engine Core ====
=== Other changes ===
  * ''[[api:game_object | GAME_OBJECT]]''
    * Changed functions
      * ''[[api:GAME_OBJECT#getorcreatecomponent | getOrCreateComponent]]''

----

==== Component Classes ====
=== Other changes ===
  * ''[[api:comp_building | COMP_BUILDING]]''
    * Added events
      * ''[[api:COMP_BUILDING#on_building_batch_change_finished | ON_BUILDING_BATCH_CHANGE_FINISHED]]''
  * ''[[api:comp_building_part | COMP_BUILDING_PART]]''
    * Removed properties
      * ''BuildingZone''
      * ''HasBuildingZone''
      * ''BuildingZoneData''
    * Added events
      * ''[[api:COMP_BUILDING_PART#on_part_destroyed | ON_PART_DESTROYED]]''
  * ''[[api:comp_workplace | COMP_WORKPLACE]]''
    * Added events
      * ''[[api:COMP_WORKPLACE#on_workplace_produced | ON_WORKPLACE_PRODUCED]]''

----

==== Enumerations ====
=== Added ===
  * ''[[api:character_part | CHARACTER_PART]]''
  * ''[[api:building_part_type | BUILDING_PART_TYPE]]''
=== Other changes ===
  * ''[[api:building_type | BUILDING_TYPE]]''
    * Added values
      * ''MASTERPIECE''
  * ''[[api:building_zone_type | BUILDING_ZONE_TYPE]]''
    * Removed values
      * ''NAV_MESH''
      * ''TREE_COLLIDING''
  * ''[[api:attach_node_type | ATTACH_NODE_TYPE]]''
    * Added values
      * ''DISABLE_BASEMENT''
    * Removed values
      * ''BRIDGE_END''

----

===== Assets Changes =====
==== PREFAB ====
=== Added ===
  * ''[[assets:prefab | PREFAB_MINERAL_SOURCE_2]]''
  * ''[[assets:prefab | PREFAB_MINERAL_SOURCE_1]]''
  * ''[[assets:prefab | PREFAB_MINERAL_SOURCE_3]]''
=== Removed ===
  * ''MINERAL_DEPOSIT''

----

==== VILLAGER_PROFILE ====
=== Added ===
  * ''[[assets:villager_profile | PROFILE_MINSTREL]]''