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_musical_part | BUILDING_FUNCTION_MUSICAL_PART]]''
  * ''[[api:building_function_unique_resource_depot | BUILDING_FUNCTION_UNIQUE_RESOURCE_DEPOT]]''
  * ''[[api:name_list | NAME_LIST]]''
=== Removed ===
  * ''BUILDING_FUNCTION_CHURCH_BELL''
=== Other changes ===
  * ''[[api:balancing | BALANCING]]''
    * Added properties
      * ''[[api:BALANCING#namelist | NameList]]''
    * Removed properties
      * ''MaleNameList''
      * ''FemaleNameList''
  * ''[[api:building_function_farm | BUILDING_FUNCTION_FARM]]''
    * Added properties
      * ''[[api:BUILDING_FUNCTION_FARM#growingsetup | GrowingSetup]]''
  * ''[[api:farm_field_config | FARM_FIELD_CONFIG]]''
    * Added properties
      * ''[[api:FARM_FIELD_CONFIG#startscalevalue | StartScaleValue]]''
      * ''[[api:FARM_FIELD_CONFIG#minvisiblescale | MinVisibleScale]]''
  * ''[[api:masterpiece | MASTERPIECE]]''
    * Added properties
      * ''[[api:MASTERPIECE#walltounlock | WallToUnlock]]''
  * ''[[api:resource | RESOURCE]]''
    * Added properties
      * ''[[api:RESOURCE#orderid | OrderId]]''
  * ''[[api:villager_profile | VILLAGER_PROFILE]]''
    * Added properties
      * ''[[api:VILLAGER_PROFILE#assignworkplacefunction | AssignWorkplaceFunction]]''

----

==== Data Classes ====
=== Added ===
  * ''[[api:quest_function_immigration | QUEST_FUNCTION_IMMIGRATION]]''
  * ''[[api:string_pair | STRING_PAIR]]''
  * ''[[api:villager_assign_workplace_function | VILLAGER_ASSIGN_WORKPLACE_FUNCTION]]''
  * ''[[api:villager_assign_workplace_function_auto_assign_job | VILLAGER_ASSIGN_WORKPLACE_FUNCTION_AUTO_ASSIGN_JOB]]''
  * ''[[api:villager_assign_workplace_function_default | VILLAGER_ASSIGN_WORKPLACE_FUNCTION_DEFAULT]]''
=== Removed ===
  * ''QUEST_FUNCTION_TIMER''
=== Other changes ===
  * ''[[api:action_visit | ACTION_VISIT]]''
    * Added properties
      * ''[[api:ACTION_VISIT#visitorwaitinteractivelocation | VisitorWaitInteractiveLocation]]''
    * Removed properties
      * ''AssetNotification''
      * ''NarrativePanelData''
  * ''[[api:building_constructor | BUILDING_CONSTRUCTOR]]''
    * Renamed properties
      * ''IsPreviewGroundVisible -> [[api:BUILDING_CONSTRUCTOR#clipundergroundinpreview | ClipUnderGroundInPreview]]''
  * ''[[api:game_condition_above_surroundings | GAME_CONDITION_ABOVE_SURROUNDINGS]]''
    * Added properties
      * ''[[api:GAME_CONDITION_ABOVE_SURROUNDINGS#checkonlymasterpiecepart | CheckOnlyMasterpiecePart]]''
  * ''[[api:mineral_category | MINERAL_CATEGORY]]''
    * Added properties
      * ''[[api:MINERAL_CATEGORY#firstdiscoveryprospectioncount | FirstDiscoveryProspectionCount]]''

----

==== Behavior Tree Node Classes ====
=== Added ===
  * ''[[api:setup_growing_work | SETUP_GROWING_WORK]]''

----

==== Behavior Tree Data Classes ====
=== Other changes ===
  * ''[[api:behavior_tree_data_resource_transport | BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT]]''
    * Added properties
      * ''[[api:BEHAVIOR_TREE_DATA_RESOURCE_TRANSPORT#transportsetup | TransportSetup]]''

----

==== Component Classes ====
=== Other changes ===
  * ''[[api:comp_building | COMP_BUILDING]]''
    * Added events
      * ''[[api:COMP_BUILDING#on_material_set_changed | ON_MATERIAL_SET_CHANGED]]''
  * ''[[api:comp_building_part | COMP_BUILDING_PART]]''
    * Added properties
      * ''[[api:COMP_BUILDING_PART#groundtohighestzonepoint | GroundToHighestZonePoint]]''
    * Renamed properties
      * ''IsGrounded -> [[api:COMP_BUILDING_PART#isalwaysgrounded | IsAlwaysGrounded]]''
  * ''[[api:comp_on_event_animation_controller | COMP_ON_EVENT_ANIMATION_CONTROLLER]]''
    * Added properties
      * ''[[api:COMP_ON_EVENT_ANIMATION_CONTROLLER#delay | Delay]]''
      * ''[[api:COMP_ON_EVENT_ANIMATION_CONTROLLER#soundnote | SoundNote]]''
  * ''[[api:comp_workplace | COMP_WORKPLACE]]''
    * Changed events
      * ''[[api:COMP_WORKPLACE#on_workplace_produced | ON_WORKPLACE_PRODUCED]]''

----

==== Enumerations ====
=== Other changes ===
  * ''[[api:building_zone_type | BUILDING_ZONE_TYPE]]''
    * Added values
      * ''GROUND_CONSTRAINT''
      * ''WATER_CONSTRAINT''
  * ''[[api:building_part_type | BUILDING_PART_TYPE]]''
    * Added values
      * ''RESOURCE_DEPOT''
      * ''QUARRY''
  * ''[[api:attach_node_type | ATTACH_NODE_TYPE]]''
    * Added values
      * ''BUILD_ORDER_DEPENDENCY''
  * ''[[api:resource_type | RESOURCE_TYPE]]''
    * Added values
      * ''GEM''
  * ''[[api:resource_layout_type | RESOURCE_LAYOUT_TYPE]]''
    * Added values
      * ''GEMS''
      * ''MARBLES''

----

===== Assets Changes =====
==== BUILDING_PART ====
=== Added ===
  * ''[[assets:building_part | BUILDING_PART_GATE_SMALL_WINDOW_PLANK]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_WALL_HERALDIC_SPLICED]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_WALL_HERALDIC_SPLIT]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_BRATTICE]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_SMALL_WINDOW_CLOSED]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_WALL_FLAG]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_WALL_HERALDIC_BLUE]]''
  * ''[[assets:building_part | BUILDING_PART_GATE_WALL_HERALDIC_STRIPED]]''
  * ''[[assets:building_part | BUILDING_PART_SCULPTURE_FOUNTAIN_OCTOGONAL_BASE]]''

----

==== GAME_RULE_MASTERPIECE ====
=== Added ===
  * ''[[assets:game_rule_masterpiece | GAME_RULE_MASTERPIECE_DEFAULT]]''

----

==== GAME_RULE_MINERAL ====
=== Renamed ===
  * ''GAME_RULE_MINERAL -> [[assets:game_rule_mineral | GAME_RULE_MINERAL_DEFAULT]]''

----

==== PARTICLE_SYSTEM ====
=== Added ===
  * ''[[assets:particle_system | PARTICLE_SYSTEM_STONECUTTER_ROCK]]''

----

==== PREFAB ====
=== Added ===
  * ''[[assets:prefab | PREFAB_MANAGER]]''
=== Removed ===
  * ''PREFAB_TOOL_GLASS_SMELTER_GRIP''
  * ''PREFAB_TOOL_GLASS_ARTIST_GLASS_PIECE''
  * ''PREFAB_TOOL_JEWELER_GEM''
  * ''PREFAB_TOOL_TAILOR_SCISSORS''
  * ''PREFAB_TOOL_GLASS_ARTIST_CUTTER''
  * ''PREFAB_TOOL_PROSPECTOR_PICKAXE''
  * ''PREFAB_TOOL_PROSPECTOR_ROCK''
  * ''PREFAB_TOOL_JEWELER_PIKE''