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 ======

===== API Changes =====
==== Asset Classes ====
=== Added ===
  * ''[[preview:api:change_edict_mandate_type | CHANGE_EDICT_MANDATE_TYPE]]''
  * ''[[preview:api:change_privilege_mandate_type | CHANGE_PRIVILEGE_MANDATE_TYPE]]''
=== Other changes ===
  * ''[[preview:api:agent_need_type_visit_building | AGENT_NEED_TYPE_VISIT_BUILDING]]''
    * Removed properties
      * ''HappinessFactorDescriptor''
  * ''[[preview:api:building | BUILDING]]''
    * Added properties
      * ''[[preview:api:BUILDING#dataconstructionvalidationconditionlist | DataConstructionValidationConditionList]]''
    * Removed properties
      * ''ConditionList''
  * ''[[preview:api:building_part | BUILDING_PART]]''
    * Removed properties
      * ''IsOutsideNavigationZone''
  * ''[[preview:api:game_rule_trade | GAME_RULE_TRADE]]''
    * Added properties
      * ''[[preview:api:GAME_RULE_TRADE#upgradequestshownarrativeaction | UpgradeQuestShowNarrativeAction]]''
      * ''[[preview:api:GAME_RULE_TRADE#upgradequestvisitaction | UpgradeQuestVisitAction]]''
      * ''[[preview:api:GAME_RULE_TRADE#outcomepaneltemplate | OutcomePanelTemplate]]''
    * Removed properties
      * ''UpgradeQuestFeedbackNarrativePanelTemplate''
      * ''UpgradeQuestFeedbackNarrativePanelTemplateFail''
    * Changed properties type
      * ''[[preview:api:GAME_RULE_TRADE#upgradequestfeedbackaction | UpgradeQuestFeedbackAction]]''
  * ''[[preview:api:military_campaign | MILITARY_CAMPAIGN]]''
    * Added properties
      * ''[[preview:api:MILITARY_CAMPAIGN#successassetoutcomepanel | SuccessAssetOutcomePanel]]''
      * ''[[preview:api:MILITARY_CAMPAIGN#failureassetoutcomepanel | FailureAssetOutcomePanel]]''
  * ''[[preview:api:military_campaign_settings | MILITARY_CAMPAIGN_SETTINGS]]''
    * Added properties
      * ''[[preview:api:MILITARY_CAMPAIGN_SETTINGS#difficultytextsettings | DifficultyTextSettings]]''
      * ''[[preview:api:MILITARY_CAMPAIGN_SETTINGS#distancetextsettings | DistanceTextSettings]]''
  * ''[[preview:api:quest_hosting_mission | QUEST_HOSTING_MISSION]]''
    * Added properties
      * ''[[preview:api:QUEST_HOSTING_MISSION#hostinggroupkey | HostingGroupKey]]''
  * ''[[preview:api:taxation_function | TAXATION_FUNCTION]]''
    * Added properties
      * ''[[preview:api:TAXATION_FUNCTION#isactivebydefault | IsActiveByDefault]]''
  * ''[[preview:api:taxation_function_housing | TAXATION_FUNCTION_HOUSING]]''
    * Added properties
      * ''[[preview:api:TAXATION_FUNCTION_HOUSING#assetbuildinglist | AssetBuildingList]]''
    * Removed properties
      * ''AssetBuilding''
  * ''[[preview:api:trading_village | TRADING_VILLAGE]]''
    * Added properties
      * ''[[preview:api:TRADING_VILLAGE#upgradeeventenvoyprofile | UpgradeEventEnvoyProfile]]''

----

==== Data Classes ====
=== Added ===
  * ''[[preview:api:game_action_add_mandate_type | GAME_ACTION_ADD_MANDATE_TYPE]]''
  * ''[[preview:api:game_action_remove_mandate_type | GAME_ACTION_REMOVE_MANDATE_TYPE]]''
  * ''[[preview:api:game_condition_agent_killed | GAME_CONDITION_AGENT_KILLED]]''
  * ''[[preview:api:game_condition_enclosed_area_size | GAME_CONDITION_ENCLOSED_AREA_SIZE]]''
  * ''[[preview:api:game_condition_military_campaign_ongoing | GAME_CONDITION_MILITARY_CAMPAIGN_ONGOING]]''
  * ''[[preview:api:game_rule_modifier_conditional_game_rule | GAME_RULE_MODIFIER_CONDITIONAL_GAME_RULE]]''
  * ''[[preview:api:game_rule_modifier_construction_refund | GAME_RULE_MODIFIER_CONSTRUCTION_REFUND]]''
  * ''[[preview:api:game_rule_modifier_free_territory | GAME_RULE_MODIFIER_FREE_TERRITORY]]''
  * ''[[preview:api:game_rule_modifier_immigration_ignore_factor | GAME_RULE_MODIFIER_IMMIGRATION_IGNORE_FACTOR]]''
  * ''[[preview:api:game_rule_modifier_mandate_cost | GAME_RULE_MODIFIER_MANDATE_COST]]''
  * ''[[preview:api:game_rule_modifier_mandate_time | GAME_RULE_MODIFIER_MANDATE_TIME]]''
  * ''[[preview:api:game_rule_modifier_soldier_strength_from_happiness | GAME_RULE_MODIFIER_SOLDIER_STRENGTH_FROM_HAPPINESS]]''
  * ''[[preview:api:game_rule_modifier_taxation_cumulation_bonus | GAME_RULE_MODIFIER_TAXATION_CUMULATION_BONUS]]''
  * ''[[preview:api:game_rule_modifier_taxation_housing_happiness_factor_multiplier | GAME_RULE_MODIFIER_TAXATION_HOUSING_HAPPINESS_FACTOR_MULTIPLIER]]''
  * ''[[preview:api:game_rule_modifier_upkeep_building_parts | GAME_RULE_MODIFIER_UPKEEP_BUILDING_PARTS]]''
  * ''[[preview:api:string_value | STRING_VALUE]]''
  * ''[[preview:api:string_value_list | STRING_VALUE_LIST]]''
=== Other changes ===
  * ''[[preview:api:game_action_visit | GAME_ACTION_VISIT]]''
    * Added properties
      * ''[[preview:api:GAME_ACTION_VISIT#visitorstatus | VisitorStatus]]''
      * ''[[preview:api:GAME_ACTION_VISIT#visitorbehaviourtree | VisitorBehaviourTree]]''
  * ''[[preview:api:game_condition_enclosed_area | GAME_CONDITION_ENCLOSED_AREA]]''
    * Added properties
      * ''[[preview:api:GAME_CONDITION_ENCLOSED_AREA#validenclosedareamaterial | ValidEnclosedAreaMaterial]]''
      * ''[[preview:api:GAME_CONDITION_ENCLOSED_AREA#invalidenclosedareamaterial | InvalidEnclosedAreaMaterial]]''
    * Removed properties
      * ''EnclosedAreaMaterial''
      * ''EntranceType''
  * ''[[preview:api:game_rule_modifier_need_type_deplete_rate | GAME_RULE_MODIFIER_NEED_TYPE_DEPLETE_RATE]]''
    * Added properties
      * ''[[preview:api:GAME_RULE_MODIFIER_NEED_TYPE_DEPLETE_RATE#agentprofile | AgentProfile]]''
      * ''[[preview:api:GAME_RULE_MODIFIER_NEED_TYPE_DEPLETE_RATE#assetvillagerstatus | AssetVillagerStatus]]''
  * ''[[preview:api:game_rule_modifier_trade_bonus | GAME_RULE_MODIFIER_TRADE_BONUS]]''
    * Added properties
      * ''[[preview:api:GAME_RULE_MODIFIER_TRADE_BONUS#tradebonustype | TradeBonusType]]''
    * Renamed properties
      * ''BonusRevenuePercentage -> [[preview:api:GAME_RULE_MODIFIER_TRADE_BONUS#bonuspercentage | BonusPercentage]]''
  * ''[[preview:api:game_rule_modifier_villager_happiness | GAME_RULE_MODIFIER_VILLAGER_HAPPINESS]]''
    * Added properties
      * ''[[preview:api:GAME_RULE_MODIFIER_VILLAGER_HAPPINESS#happinessfactormultiplier | HappinessFactorMultiplier]]''
  * ''[[preview:api:mandate | MANDATE]]''
    * Added functions
      * ''[[preview:api:MANDATE#getcost | getCost]]''
      * ''[[preview:api:MANDATE#addmandatecostmodifier | addMandateCostModifier]]''
      * ''[[preview:api:MANDATE#removemandatecostmodifier | removeMandateCostModifier]]''
      * ''[[preview:api:MANDATE#addmandatetimemodifier | addMandateTimeModifier]]''
      * ''[[preview:api:MANDATE#removemandatetimemodifier | removeMandateTimeModifier]]''

----

==== Behavior Tree Node Classes ====
=== Added ===
  * ''[[preview:api:change_edict | CHANGE_EDICT]]''
  * ''[[preview:api:change_privilege | CHANGE_PRIVILEGE]]''
  * ''[[preview:api:setup_change_edict | SETUP_CHANGE_EDICT]]''
  * ''[[preview:api:setup_change_privilege | SETUP_CHANGE_PRIVILEGE]]''

----

==== Behavior Tree Data Classes ====
=== Added ===
  * ''[[preview:api:behavior_tree_data_agent_need | BEHAVIOR_TREE_DATA_AGENT_NEED]]''
  * ''[[preview:api:behavior_tree_data_happiness_factor | BEHAVIOR_TREE_DATA_HAPPINESS_FACTOR]]''
  * ''[[preview:api:behavior_tree_data_resource_consumption | BEHAVIOR_TREE_DATA_RESOURCE_CONSUMPTION]]''
  * ''[[preview:api:behavior_tree_data_resource_type | BEHAVIOR_TREE_DATA_RESOURCE_TYPE]]''
=== Other changes ===
  * ''[[preview:api:behavior_tree_data_loop | BEHAVIOR_TREE_DATA_LOOP]]''
    * Added properties
      * ''[[preview:api:BEHAVIOR_TREE_DATA_LOOP#maximumduration | MaximumDuration]]''

----

==== Engine Core ====
=== Other changes ===
  * ''[[preview:api:game_object | GAME_OBJECT]]''
    * Changed functions
      * ''[[preview:api:GAME_OBJECT#foreachchild | forEachChild]]''
      * ''[[preview:api:GAME_OBJECT#foreachchildrecursive | forEachChildRecursive]]''
      * ''[[preview:api:GAME_OBJECT#foreachcomponent | forEachComponent]]''
      * ''[[preview:api:GAME_OBJECT#foreachcomponentreverse | forEachComponentReverse]]''
  * ''[[preview:api:level | LEVEL]]''
    * Removed functions
      * ''registerRuntimeAsset''
      * ''unregisterRuntimeAsset''

----

==== Component Classes ====
=== Added ===
  * ''[[preview:api:comp_interactive_location | COMP_INTERACTIVE_LOCATION]]''
=== Other changes ===
  * ''[[preview:api:comp_building | COMP_BUILDING]]''
    * Added events
      * ''[[preview:api:COMP_BUILDING#on_sub_building_destroyed | ON_SUB_BUILDING_DESTROYED]]''
  * ''[[preview:api:comp_building_attach_node | COMP_BUILDING_ATTACH_NODE]]''
    * Added functions
      * ''[[preview:api:COMP_BUILDING_ATTACH_NODE#getparentpart | getParentPart]]''
  * ''[[preview:api:comp_resource_depot | COMP_RESOURCE_DEPOT]]''
    * Added properties
      * ''[[preview:api:COMP_RESOURCE_DEPOT#iswarehouse | IsWarehouse]]''
  * ''[[preview:api:comp_soldier | COMP_SOLDIER]]''
    * Added functions
      * ''[[preview:api:COMP_SOLDIER#computestrength | computeStrength]]''
    * Changed functions
      * ''[[preview:api:COMP_SOLDIER#getstrength | getStrength]]''
    * Added events
      * ''[[preview:api:COMP_SOLDIER#on_strength_updated | ON_STRENGTH_UPDATED]]''

----

==== Enumerations ====
=== Added ===
  * ''[[preview:api:trade_bonus_type | TRADE_BONUS_TYPE]]''
=== Other changes ===
  * ''[[preview:api:building_zone_type | BUILDING_ZONE_TYPE]]''
    * Added values
      * ''NAVIGABLE_EXTERIOR''
  * ''[[preview:api:building_part_type | BUILDING_PART_TYPE]]''
    * Added values
      * ''CHIMNEY''
  * ''[[preview:api:resource_type | RESOURCE_TYPE]]''
    * Added values
      * ''MONASTIC_MEAL''

----

===== Assets Changes =====
==== AGENT_PROFILE ====
=== Added ===
  * ''[[preview:assets:agent_profile | PROFILE_ENVOY_ROYAL]]''

----

==== MILITARY_CAMPAIGN ====
  * Removed all [[preview:assets:military_campaign | MILITARY_CAMPAIGN]] assets

----

==== RESOURCE ====
=== Added ===
  * ''[[preview:assets:resource | MANUSCRIPT]]''

----

==== UNLOCKABLE ====
=== Added ===
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_MONASTERY_REFECTORY]]''
=== Removed ===
  * ''UNLOCKABLE_CLERGY_PRIVILEGESLOT_1''
  * ''UNLOCKABLE_CLERGY_PRIVILEGESLOT_2''
  * ''UNLOCKABLE_KINGDOM_PRIVILEGESLOT_1''
  * ''UNLOCKABLE_KINGDOM_PRIVILEGESLOT_2''
  * ''UNLOCKABLE_LABOUR_PRIVILEGESLOT_1''
  * ''UNLOCKABLE_LABOUR_PRIVILEGESLOT_2''

----

==== UNLOCKABLE_EDICT ====
=== Added ===
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_MONASTERY_MODEST_CLOISTER]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_MONASTERY_MODEST_SET]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_MONASTERY_RUSTIC_DECORATIVE]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_MONASTERY_RUSTIC_SPLENDOR]]''
=== Removed ===
  * ''UNLOCKABLE_CLERGY_CHURCH_RUSTIC_DECORATIVE''

----

==== UNLOCKABLE_PRIVILEGE ====
=== Added ===
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_TRADE_BONUS]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_CLERGY_PRIVILEGE_NOPENALTY_KINGDOM]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_KINGDOM_WIP]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_LABOUR_TRADE_BONUS]]''
  * ''[[preview:assets:unlockable | UNLOCKABLE_LABOUR_WIP]]''
=== Removed ===
  * ''UNLOCKABLE_CLERGY_PRIVILEGE_NOPENALTY''
  * ''UNLOCKABLE_KINGDOM_PRIVILEGE_NOPENALTY''