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:house_requirement | HOUSE_REQUIREMENT]]''
  * ''[[api:house_requirement_in_layer | HOUSE_REQUIREMENT_IN_LAYER]]''
  * ''[[api:house_requirement_villager_status | HOUSE_REQUIREMENT_VILLAGER_STATUS]]''
  * ''[[api:house_requirement_zone | HOUSE_REQUIREMENT_ZONE]]''
  * ''[[api:information_layer_building | INFORMATION_LAYER_BUILDING]]''
  * ''[[api:information_layer_building_beautification | INFORMATION_LAYER_BUILDING_BEAUTIFICATION]]''
  * ''[[api:information_layer_building_splendor | INFORMATION_LAYER_BUILDING_SPLENDOR]]''
  * ''[[api:information_layer_building_undesirability | INFORMATION_LAYER_BUILDING_UNDESIRABILITY]]''
  * ''[[api:visibility_layer | VISIBILITY_LAYER]]''
  * ''[[api:visibility_layer_building | VISIBILITY_LAYER_BUILDING]]''
  * ''[[api:visibility_layer_desirability | VISIBILITY_LAYER_DESIRABILITY]]''
=== Removed ===
  * ''NEED_SATISFACTION_HOUSE_SELECTION_FACTOR''
=== Other changes ===
  * ''[[api:agent_need_type | AGENT_NEED_TYPE]]''
    * Added properties
      * ''[[api:AGENT_NEED_TYPE#isneedfirstconsumptionbeforelacking | IsNeedFirstConsumptionBeforeLacking]]''
  * ''[[api:building_part | BUILDING_PART]]''
    * Added properties
      * ''[[api:BUILDING_PART#beautificationcategory | BeautificationCategory]]''
      * ''[[api:BUILDING_PART#undesirabilityvalue | UndesirabilityValue]]''
  * ''[[api:desirability | DESIRABILITY]]''
    * Removed properties
      * ''ButtonIconList''
      * ''Description''
      * ''IsShowTooltip''
      * ''Visible''
  * ''[[api:house_manager_data | HOUSE_MANAGER_DATA]]''
    * Removed properties
      * ''IncompatibleHouseFactorCost''
  * ''[[api:house_setup | HOUSE_SETUP]]''
    * Added properties
      * ''[[api:HOUSE_SETUP#houseupgradestatusdelay | HouseUpgradeStatusDelay]]''
      * ''[[api:HOUSE_SETUP#housedowngradestatusdelay | HouseDowngradeStatusDelay]]''
  * ''[[api:material | MATERIAL]]''
    * Added properties
      * ''[[api:MATERIAL#stencilmask | StencilMask]]''
  * ''[[api:notification | NOTIFICATION]]''
    * Added properties
      * ''[[api:NOTIFICATION#category | Category]]''
  * ''[[api:trading_village | TRADING_VILLAGE]]''
    * Changed properties type
      * ''[[api:TRADING_VILLAGE#buyingresourcelist | BuyingResourceList]]''
      * ''[[api:TRADING_VILLAGE#sellingresourcelist | SellingResourceList]]''

----

==== Data Classes ====
=== Added ===
  * ''[[api:beautification_category_boost | BEAUTIFICATION_CATEGORY_BOOST]]''
  * ''[[api:game_rule_modifier_building_beautification | GAME_RULE_MODIFIER_BUILDING_BEAUTIFICATION]]''
=== Removed ===
  * ''RESOURCE_TRADING_INFO''
=== Other changes ===
  * ''[[api:game_rule_modifier_improve_area_desirability | GAME_RULE_MODIFIER_IMPROVE_AREA_DESIRABILITY]]''
    * Added properties
      * ''[[api:GAME_RULE_MODIFIER_IMPROVE_AREA_DESIRABILITY#ishidden | IsHidden]]''
  * ''[[api:house_status | HOUSE_STATUS]]''
    * Added properties
      * ''[[api:HOUSE_STATUS#assethouserequirementlist | AssetHouseRequirementList]]''
      * ''[[api:HOUSE_STATUS#houseicon | HouseIcon]]''
      * ''[[api:HOUSE_STATUS#name | Name]]''
      * ''[[api:HOUSE_STATUS#description | Description]]''

----

==== Data Structures ====
=== Other changes ===
  * ''[[api:polygon | polygon]]''
    * Added functions
      * ''[[api:polygon#edgedistance | edgeDistance]]''
      * ''[[api:polygon#edgedistance2 | edgeDistance2]]''
    * Changed functions
      * ''[[api:polygon#distance | distance]]''
      * ''[[api:polygon#distance2 | distance2]]''
  * ''[[api:vec2d | vec2d]]''
    * Added functions
      * ''[[api:vec2d#rotated | rotated]]''
  * ''[[api:vec2f | vec2f]]''
    * Added functions
      * ''[[api:vec2f#rotated | rotated]]''
  * ''[[api:vec2i | vec2i]]''
    * Added functions
      * ''[[api:vec2i#rotated | rotated]]''

----

==== Component Classes ====
=== Added ===
  * ''[[api:comp_trader | COMP_TRADER]]''
  * ''[[api:comp_vehicle | COMP_VEHICLE]]''
=== Other changes ===
  * ''[[api:comp_agent | COMP_AGENT]]''
    * Added functions
      * ''[[api:COMP_AGENT#getvehicle | getVehicle]]''
    * Changed functions
      * ''[[api:COMP_AGENT#setvehicle | setVehicle]]''
    * Added events
      * ''[[api:COMP_AGENT#on_vehicle_changed | ON_VEHICLE_CHANGED]]''
  * ''[[api:comp_building | COMP_BUILDING]]''
    * Added events
      * ''[[api:COMP_BUILDING#on_preview_part_moved | ON_PREVIEW_PART_MOVED]]''

----

==== Enumerations ====
=== Added ===
  * ''[[api:beautification_category | BEAUTIFICATION_CATEGORY]]''
=== Other changes ===
  * ''[[api:material_render_mode | MATERIAL_RENDER_MODE]]''
    * Added values
      * ''TRANSPARENT_LATE''
  * ''[[api:building_status | BUILDING_STATUS]]''
    * Added values
      * ''MISSING_HOUSING_REQUIREMENT''
  * ''[[api:notification_type | NOTIFICATION_TYPE]]''
    * Added values
      * ''DEFAULT''

----

===== Assets Changes =====
==== DESIRABILITY_MODIFIER ====
  * Removed all [[assets:desirability_modifier | DESIRABILITY_MODIFIER]] assets

----

==== PREFAB ====
=== Added ===
  * ''[[assets:prefab | PREFAB_BODY_FEMALE_DEFAULT]]''
  * ''[[assets:prefab | PREFAB_BODY_MALE_DEFAULT]]''
  * ''[[assets:prefab | PREFAB_TOOL_TAILOR_SCISSORS]]''