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 ===
  * ''[[api:building_function_resource_stockpile | BUILDING_FUNCTION_RESOURCE_STOCKPILE]]''
=== Removed ===
  * ''BUILDING_PART_COST_LIST''
=== Renamed ===
  * ''VILLAGER_PROFILE -> [[api:agent_profile | AGENT_PROFILE]]''
    * Added properties
      * ''[[api:AGENT_PROFILE#allowunemployedvillager | AllowUnemployedVillager]]''
  * ''BUILDING_FUNCTION_LIST -> [[api:assignable_building_function_list | ASSIGNABLE_BUILDING_FUNCTION_LIST]]''
  * ''AGENT_WORKSTATION_SETUP -> [[api:interactive_location_setup | INTERACTIVE_LOCATION_SETUP]]''
    * Added properties
      * ''[[api:INTERACTIVE_LOCATION_SETUP#purposelist | PurposeList]]''
    * Removed properties
      * ''LocationTypeList''
=== Other changes ===
  * ''[[api:balancing | BALANCING]]''
    * Removed properties
      * ''BuildingCostOverrideList''
      * ''PlantableList''
  * ''[[api:building_function | BUILDING_FUNCTION]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION#gamerulemodifierlist | GameRuleModifierList]]''
      * ''[[api:BUILDING_FUNCTION#isdescriptionoverride | IsDescriptionOverride]]''
      * ''[[api:BUILDING_FUNCTION#shownameintags | ShowNameInTags]]''
      * ''[[api:BUILDING_FUNCTION#isdisplayable | IsDisplayable]]''
  * ''[[api:building_function_forester | BUILDING_FUNCTION_FORESTER]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_FORESTER#plantableassetlist | PlantableAssetList]]''
  * ''[[api:building_function_point_of_interest | BUILDING_FUNCTION_POINT_OF_INTEREST]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_POINT_OF_INTEREST#visitorpurpose | VisitorPurpose]]''
  * ''[[api:building_function_training_ground | BUILDING_FUNCTION_TRAINING_GROUND]]''
    * Renamed properties
      * ''VillagerProfile -> [[api:BUILDING_FUNCTION_TRAINING_GROUND#agentprofile | AgentProfile]]''
  * ''[[api:mandate_type | MANDATE_TYPE]]''
    * Added properties
      * ''[[api:MANDATE_TYPE#workplace | Workplace]]''
    * Added functions
      * ''[[api:MANDATE_TYPE#init | init]]''
      * ''[[api:MANDATE_TYPE#generatepossiblemandatelist | generatePossibleMandateList]]''
  * ''[[api:quest | QUEST]]''
    * Renamed properties
      * ''QuestRewardList -> [[api:QUEST#questrewardactionlist | QuestRewardActionList]]''
      * ''QuestFailList -> [[api:QUEST#questfailactionlist | QuestFailActionList]]''
    * Changed properties type
      * ''[[api:QUEST#questrewardactionlist | QuestRewardActionList]]''
      * ''[[api:QUEST#questfailactionlist | QuestFailActionList]]''
  * ''[[api:resource | RESOURCE]]''
    * Added properties
      * ''[[api:RESOURCE#individualresourcevisualprefab | IndividualResourceVisualPrefab]]''
  * ''[[api:villager_status | VILLAGER_STATUS]]''
    * Added properties
      * ''[[api:VILLAGER_STATUS#assetvillagerneedtoremovelist | AssetVillagerNeedToRemoveList]]''

----

==== Data Classes ====
=== Added ===
  * ''[[api:curve_float | CURVE_FLOAT]]''
  * ''[[api:event_action_trigger_military_campaign | EVENT_ACTION_TRIGGER_MILITARY_CAMPAIGN]]''
  * ''[[api:game_action_trigger_event_callback | GAME_ACTION_TRIGGER_EVENT_CALLBACK]]''
  * ''[[api:game_rule_modifier_descriptor_building_part | GAME_RULE_MODIFIER_DESCRIPTOR_BUILDING_PART]]''
  * ''[[api:game_rule_modifier_workplace_recipe | GAME_RULE_MODIFIER_WORKPLACE_RECIPE]]''
  * ''[[api:random_integer_range | RANDOM_INTEGER_RANGE]]''
  * ''[[api:random_vector2_range | RANDOM_VECTOR2_RANGE]]''
  * ''[[api:reserved_resource_element | RESERVED_RESOURCE_ELEMENT]]''
  * ''[[api:reserved_resource_list | RESERVED_RESOURCE_LIST]]''
  * ''[[api:resource_collection_value | RESOURCE_COLLECTION_VALUE]]''
=== Removed ===
  * ''QUEST_REWARD''
  * ''QUEST_REWARD_MARKET_PRICES''
=== Renamed ===
  * ''EVENT_ACTION -> [[api:game_action | GAME_ACTION]]''
    * Removed properties
      * ''OnClickCallback''
    * Added functions
      * ''[[api:GAME_ACTION#execute | execute]]''
      * ''[[api:GAME_ACTION#cancelaction | cancelAction]]''
      * ''[[api:GAME_ACTION#getheadertext | getHeaderText]]''
      * ''[[api:GAME_ACTION#hastooltipview | hasTooltipView]]''
  * ''QUEST_REWARD_GAME_RULE -> [[api:game_action_apply_game_rule | GAME_ACTION_APPLY_GAME_RULE]]''
  * ''QUEST_REWARD_BLUEPRINT -> [[api:game_action_give_blueprint | GAME_ACTION_GIVE_BLUEPRINT]]''
  * ''QUEST_REWARD_INFLUENCE -> [[api:game_action_give_influence | GAME_ACTION_GIVE_INFLUENCE]]''
  * ''QUEST_REWARD_RANDOM_RESOURCE -> [[api:game_action_give_random_resource | GAME_ACTION_GIVE_RANDOM_RESOURCE]]''
  * ''QUEST_REWARD_RESOURCES -> [[api:game_action_give_resource_list | GAME_ACTION_GIVE_RESOURCE_LIST]]''
  * ''QUEST_REWARD_TERRITORY -> [[api:game_action_give_territory | GAME_ACTION_GIVE_TERRITORY]]''
  * ''QUEST_REWARD_STUB -> [[api:game_action_stub | GAME_ACTION_STUB]]''
  * ''QUEST_REWARD_IMMIGRATION_WAVE -> [[api:game_action_trigger_immigration_wave | GAME_ACTION_TRIGGER_IMMIGRATION_WAVE]]''
  * ''QUEST_REWARD_UNLOCK_BUILDING_LIST -> [[api:game_action_unlock_building_list | GAME_ACTION_UNLOCK_BUILDING_LIST]]''
=== Other changes ===
  * ''[[api:action_visit | ACTION_VISIT]]''
    * Added properties
      * ''[[api:ACTION_VISIT#visitorpurpose | VisitorPurpose]]''
    * Renamed properties
      * ''VisitorWaitInteractiveLocation -> [[api:ACTION_VISIT#overrideinteractivelocationsetup | OverrideInteractiveLocationSetup]]''
  * ''[[api:building_part_cost | BUILDING_PART_COST]]''
    * Added properties
      * ''[[api:BUILDING_PART_COST#resourceneededlist | ResourceNeededList]]''
    * Removed properties
      * ''RessourcesNeeded''
  * ''[[api:character_setup | CHARACTER_SETUP]]''
    * Added properties
      * ''[[api:CHARACTER_SETUP#malecloaklist | MaleCloakList]]''
      * ''[[api:CHARACTER_SETUP#femalecloaklist | FemaleCloakList]]''
  * ''[[api:event_action_give_reward | EVENT_ACTION_GIVE_REWARD]]''
    * Added properties
      * ''[[api:EVENT_ACTION_GIVE_REWARD#actionlist | ActionList]]''
    * Removed properties
      * ''QuestRewardList''
  * ''[[api:mandate | MANDATE]]''
    * Added properties
      * ''[[api:MANDATE#assetmandate | AssetMandate]]''
      * ''[[api:MANDATE#name | Name]]''
      * ''[[api:MANDATE#workplace | Workplace]]''
      * ''[[api:MANDATE#behavior | Behavior]]''
      * ''[[api:MANDATE#resourcelistneeded | ResourceListNeeded]]''
    * Added functions
      * ''[[api:MANDATE#getremainingtime | getRemainingTime]]''
      * ''[[api:MANDATE#decreaseremainingtime | decreaseRemainingTime]]''
      * ''[[api:MANDATE#getremainingtimeratio | getRemainingTimeRatio]]''
  * ''[[api:map_density_prefab_config | MAP_DENSITY_PREFAB_CONFIG]]''
    * Changed properties type
      * ''[[api:MAP_DENSITY_PREFAB_CONFIG#offsetsizerange | OffsetSizeRange]]''
      * ''[[api:MAP_DENSITY_PREFAB_CONFIG#orientationrange | OrientationRange]]''
      * ''[[api:MAP_DENSITY_PREFAB_CONFIG#scalerange | ScaleRange]]''
      * ''[[api:MAP_DENSITY_PREFAB_CONFIG#colorrange | ColorRange]]''
  * ''[[api:quest_function | QUEST_FUNCTION]]''
    * Added properties
      * ''[[api:QUEST_FUNCTION#clickinstructiontext | ClickInstructionText]]''
  * ''[[api:quest_function_send_troops | QUEST_FUNCTION_SEND_TROOPS]]''
    * Added properties
      * ''[[api:QUEST_FUNCTION_SEND_TROOPS#questrewardactionlist | QuestRewardActionList]]''
    * Removed properties
      * ''QuestRewardList''
  * ''[[api:quest_reward_probability | QUEST_REWARD_PROBABILITY]]''
    * Added properties
      * ''[[api:QUEST_REWARD_PROBABILITY#actionlist | ActionList]]''
    * Removed properties
      * ''QuestRewardList''
  * ''[[api:vehicle_animation | VEHICLE_ANIMATION]]''
    * Changed properties type
      * ''[[api:VEHICLE_ANIMATION#rideranimation | RiderAnimation]]''

----

==== Behavior Tree Node Classes ====
=== Added ===
  * ''[[api:check_if_not_null | CHECK_IF_NOT_NULL]]''
  * ''[[api:check_if_true | CHECK_IF_TRUE]]''
  * ''[[api:drop_stuff_to_depot | DROP_STUFF_TO_DEPOT]]''
  * ''[[api:gain_influence | GAIN_INFLUENCE]]''
  * ''[[api:influence_estate | INFLUENCE_ESTATE]]''
  * ''[[api:setup_influence_mandate | SETUP_INFLUENCE_MANDATE]]''
  * ''[[api:setup_study | SETUP_STUDY]]''
  * ''[[api:setup_workplace_transport | SETUP_WORKPLACE_TRANSPORT]]''
  * ''[[api:set_agent_unavailable | SET_AGENT_UNAVAILABLE]]''
  * ''[[api:succeeder | SUCCEEDER]]''
=== Renamed ===
  * ''FINISH_PRODUCTION -> [[api:finish_work_shift | FINISH_WORK_SHIFT]]''
  * ''START_PRODUCTION -> [[api:start_work_shift | START_WORK_SHIFT]]''

----

==== Behavior Tree Data Classes ====
=== Added ===
  * ''[[api:behavior_tree_data_interactive_location_purpose | BEHAVIOR_TREE_DATA_INTERACTIVE_LOCATION_PURPOSE]]''
  * ''[[api:behavior_tree_data_resource | BEHAVIOR_TREE_DATA_RESOURCE]]''
  * ''[[api:behavior_tree_data_resource_production | BEHAVIOR_TREE_DATA_RESOURCE_PRODUCTION]]''
  * ''[[api:behavior_tree_data_void_object | BEHAVIOR_TREE_DATA_VOID_OBJECT]]''
=== Renamed ===
  * ''BEHAVIOR_TREE_DATA_WORKSTATION_SETUP -> [[api:behavior_tree_data_interactive_location_setup | BEHAVIOR_TREE_DATA_INTERACTIVE_LOCATION_SETUP]]''
=== Other changes ===
  * ''[[api:behavior_tree_data_gathering | BEHAVIOR_TREE_DATA_GATHERING]]''
    * Added properties
      * ''[[api:BEHAVIOR_TREE_DATA_GATHERING#resourcecontainerlist | ResourceContainerList]]''
      * ''[[api:BEHAVIOR_TREE_DATA_GATHERING#job | Job]]''
      * ''[[api:BEHAVIOR_TREE_DATA_GATHERING#resourcecontainer | ResourceContainer]]''
      * ''[[api:BEHAVIOR_TREE_DATA_GATHERING#workplace | Workplace]]''
      * ''[[api:BEHAVIOR_TREE_DATA_GATHERING#outputresourcemultiplicator | OutputResourceMultiplicator]]''
  * ''[[api:behavior_tree_data_resource_transport | BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT]]''
    * Added properties
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#fromdepot | FromDepot]]''
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#reserver | Reserver]]''
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#toinventory | ToInventory]]''
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#currenttransportingcollection | CurrentTransportingCollection]]''
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#resourcelisttotransport | ResourceListToTransport]]''
  * ''[[api:behavior_tree_data_wait | BEHAVIOR_TREE_DATA_WAIT]]''
    * Added properties
      * ''[[api:BEHAVIOR_TREE_DATA_WAIT#timeleft | TimeLeft]]''

----

==== Engine Core ====
=== Other changes ===
  * ''[[api:component | COMPONENT]]''
    * Added properties
      * ''[[api:COMPONENT#enabled | Enabled]]''
    * Deprecated functions
      * ''[[api:COMPONENT#isenabled | isEnabled]]''
  * ''[[api:game_object | GAME_OBJECT]]''
    * Changed functions
      * ''[[api:GAME_OBJECT#findfirstobjectwithcomponentdown | findFirstObjectWithComponentDown]]''

----

==== Component Classes ====
=== Added ===
  * ''[[api:comp_bailiff_office | COMP_BAILIFF_OFFICE]]''
  * ''[[api:comp_immigration_manager | COMP_IMMIGRATION_MANAGER]]''
  * ''[[api:comp_inventory | COMP_INVENTORY]]''
  * ''[[api:comp_resource_depot | COMP_RESOURCE_DEPOT]]''
  * ''[[api:comp_resource_stockpile | COMP_RESOURCE_STOCKPILE]]''
  * ''[[api:comp_soldier | COMP_SOLDIER]]''
  * ''[[api:comp_villager_manager | COMP_VILLAGER_MANAGER]]''
=== Other changes ===
  * ''[[api:comp_agent | COMP_AGENT]]''
    * Added properties
      * ''[[api:COMP_AGENT#behaviormessage | BehaviorMessage]]''
      * ''[[api:COMP_AGENT#activitymessage | ActivityMessage]]''
      * ''[[api:COMP_AGENT#isdying | IsDying]]''
      * ''[[api:COMP_AGENT#iswounded | IsWounded]]''
      * ''[[api:COMP_AGENT#gender | Gender]]''
    * Added functions
      * ''[[api:COMP_AGENT#isonwater | isOnWater]]''
      * ''[[api:COMP_AGENT#setprofile | setProfile]]''
      * ''[[api:COMP_AGENT#getprofile | getProfile]]''
      * ''[[api:COMP_AGENT#isonboat | isOnBoat]]''
    * Deprecated functions
      * ''[[api:COMP_AGENT#setactivitymessage | setActivityMessage]]''
      * ''[[api:COMP_AGENT#setbehaviormessage | setBehaviorMessage]]''
  * ''[[api:comp_building_attach_node | COMP_BUILDING_ATTACH_NODE]]''
    * Added functions
      * ''[[api:COMP_BUILDING_ATTACH_NODE#setattachnodetype | setAttachNodeType]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#addattachnodetype | addAttachNodeType]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#isnodetype | isNodeType]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#getlinkedbuildingattachnode | getLinkedBuildingAttachNode]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#isavailable | isAvailable]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#iscompatiblewithothernode | isCompatibleWithOtherNode]]''
      * ''[[api:COMP_BUILDING_ATTACH_NODE#isattached | isAttached]]''
  * ''[[api:comp_building_manager | COMP_BUILDING_MANAGER]]''
    * Changed functions
      * ''[[api:COMP_BUILDING_MANAGER#canassignbuildingfunction | canAssignBuildingFunction]]''
      * ''[[api:COMP_BUILDING_MANAGER#getassignedbuildingfunctioncount | getAssignedBuildingFunctionCount]]''
  * ''[[api:comp_resource_generator | COMP_RESOURCE_GENERATOR]]''
    * Changed functions
      * ''[[api:COMP_RESOURCE_GENERATOR#setmaxquantity | setMaxQuantity]]''
  * ''[[api:comp_workplace | COMP_WORKPLACE]]''
    * Added properties
      * ''[[api:COMP_WORKPLACE#activelyworkingvillagerlist | ActivelyWorkingVillagerList]]''
    * Removed properties
      * ''PendingProductionCount''

----

==== Enumerations ====
=== Added ===
  * ''[[api:interactive_location_purpose | INTERACTIVE_LOCATION_PURPOSE]]''
  * ''[[api:resource_stockpile_visual_mode | RESOURCE_STOCKPILE_VISUAL_MODE]]''
=== Other changes ===
  * ''[[api:agent_animation | AGENT_ANIMATION]]''
    * Added values
      * ''SLEEP''
  * ''[[api:character_part | CHARACTER_PART]]''
    * Added values
      * ''CLOAK''
  * ''[[api:building_part_type | BUILDING_PART_TYPE]]''
    * Added values
      * ''MARKET_STALL''
      * ''ROOM''
    * Removed values
      * ''MARKET_TABLE''
  * ''[[api:resource_type | RESOURCE_TYPE]]''
    * Added values
      * ''MATERIAL''

----

===== Assets Changes =====
==== BEHAVIOR_TREE ====
=== Added ===
  * ''[[assets:behavior_tree | BEHAVIOR_BUILDER_CRAFTING]]''

----

==== BUILDING ====
=== Added ===
  * ''[[assets:building | CANDLE_WORKSHOP]]''
  * ''[[assets:building | BUILDING_COMMON_WARES_WORKSHOP]]''

----

==== BUILDING_FUNCTION ====
=== Added ===
  * ''[[assets:building_function | BUILDING_FUNCTION_CANDLE_WORKSHOP_EXTENSION]]''
  * ''[[assets:building_function | BUILDING_FUNCTION_COMMON_WARES_TOWER]]''

----

==== BUILDING_FUNCTION_WORKPLACE ====
=== Added ===
  * ''[[assets:building_function | BUILDING_FUNCTION_COMMON_WARES_WORKSHOP]]''
  * ''[[assets:building_function | BUILDING_FUNCTION_CANDLE_WORKSHOP]]''

----

==== BUILDING_PART ====
=== Added ===
  * ''[[assets:building_part | BUILDING_PART_CANDLE_WORKSHOP_CORE]]''
  * ''[[assets:building_part | BUILDING_PART_COMMON_WARES_WORKSHOP_CORE]]''
  * ''[[assets:building_part | BUILDING_PART_CANDLE_WORKSHOP_EXTENSION]]''
  * ''[[assets:building_part | BUILDING_PART_COMMON_WARES_WORKSHOP_TOWER]]''

----

==== INTERACTIVE_LOCATION_SETUP ====
=== Added ===
  * ''[[assets:interactive_location_setup | INTERACTIVE_LOCATION_SETUP_TRANSPORT]]''

----

==== JOB ====
=== Added ===
  * ''[[assets:job | CANDLE_MAKER]]''
  * ''[[assets:job | COMMON_WARES_MAKER]]''

----

==== PREFAB ====
=== Added ===
  * ''[[assets:prefab | PREFAB_RESOURCE_VISUAL_CANDLES_CRATE]]''
  * ''[[assets:prefab | PREFAB_RESOURCE_VISUAL_COMMON_WARES_CRATE]]''

----

==== RESOURCE ====
=== Added ===
  * ''[[assets:resource | COMMON_WARES]]''
  * ''[[assets:resource | CANDLE]]''
  * ''[[assets:resource | WAX]]''

----

==== VILLAGER_NEED_TYPE ====
=== Renamed ===
  * ''NEED_PRIMARY_NEED -> [[assets:villager_need_type | NEED_WATER]]''