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:execute_action_list_mandate_type | EXECUTE_ACTION_LIST_MANDATE_TYPE]]''
  * ''[[api:game_rule_mandate | GAME_RULE_MANDATE]]''
  * ''[[api:immigration_settings | IMMIGRATION_SETTINGS]]''
=== Other changes ===
  * ''[[api:agent_profile | AGENT_PROFILE]]''
    * Added properties
      * ''[[api:AGENT_PROFILE#profilenamegendered | ProfileNameGendered]]''
      * ''[[api:AGENT_PROFILE#profilenamepluralgendered | ProfileNamePluralGendered]]''
    * Removed properties
      * ''ProfileName''
      * ''ProfileNamePlural''
  * ''[[api:balancing | BALANCING]]''
    * Added properties
      * ''[[api:BALANCING#assetimmigrationsettings | AssetImmigrationSettings]]''
  * ''[[api:building_function | BUILDING_FUNCTION]]''
    * Added functions
      * ''[[api:BUILDING_FUNCTION#onbuildingfunctionknown | onBuildingFunctionKnown]]''
  * ''[[api:building_function_great_hall | BUILDING_FUNCTION_GREAT_HALL]]''
    * Removed properties
      * ''MandateAvailableNotificationData''
  * ''[[api:building_function_monastery | BUILDING_FUNCTION_MONASTERY]]''
    * Removed properties
      * ''NunVillagerProfile''
  * ''[[api:game_rule_trade | GAME_RULE_TRADE]]''
    * Added properties
      * ''[[api:GAME_RULE_TRADE#soldtotraderpermonthfactormultiplier | SoldToTraderPerMonthFactorMultiplier]]''
      * ''[[api:GAME_RULE_TRADE#boughtfromtraderpermonthfactormultiplier | BoughtFromTraderPerMonthFactorMultiplier]]''
    * Removed properties
      * ''TradePerMonthFactorMultiplier''
  * ''[[api:material | MATERIAL]]''
    * Added properties
      * ''[[api:MATERIAL#hasdepthtest | HasDepthTest]]''
  * ''[[api:unlock_function | UNLOCK_FUNCTION]]''
    * Removed properties
      * ''GameStateFlag''
  * ''[[api:villager_status | VILLAGER_STATUS]]''
    * Added properties
      * ''[[api:VILLAGER_STATUS#statusnamegendered | StatusNameGendered]]''
      * ''[[api:VILLAGER_STATUS#statusdescriptiongendered | StatusDescriptionGendered]]''
      * ''[[api:VILLAGER_STATUS#titlegendered | TitleGendered]]''
    * Removed properties
      * ''StatusDescription''
      * ''StatusName''
      * ''Title''

----

==== Data Classes ====
=== Added ===
  * ''[[api:agent_profile_gender_usage_pair | AGENT_PROFILE_GENDER_USAGE_PAIR]]''
  * ''[[api:character_setup_data | CHARACTER_SETUP_DATA]]''
  * ''[[api:game_action_apply_happiness_factor | GAME_ACTION_APPLY_HAPPINESS_FACTOR]]''
  * ''[[api:game_action_give_resource_list_per_villager_status | GAME_ACTION_GIVE_RESOURCE_LIST_PER_VILLAGER_STATUS]]''
  * ''[[api:game_action_snooze_recuring_event | GAME_ACTION_SNOOZE_RECURING_EVENT]]''
  * ''[[api:immigration_probability_setting | IMMIGRATION_PROBABILITY_SETTING]]''
  * ''[[api:progress_unlock_estate_decoration | PROGRESS_UNLOCK_ESTATE_DECORATION]]''
  * ''[[api:unlock_function_instance | UNLOCK_FUNCTION_INSTANCE]]''
  * ''[[api:villager_status_gender_usage_pair | VILLAGER_STATUS_GENDER_USAGE_PAIR]]''
=== Renamed ===
  * ''VILLAGER_STATUS_COST -> [[api:villager_status_resource_list_pair | VILLAGER_STATUS_RESOURCE_LIST_PAIR]]''
    * Renamed properties
      * ''Cost -> [[api:VILLAGER_STATUS_RESOURCE_LIST_PAIR#resourcecollection | ResourceCollection]]''
=== Other changes ===
  * ''[[api:agent_profile_function | AGENT_PROFILE_FUNCTION]]''
    * Added properties
      * ''[[api:AGENT_PROFILE_FUNCTION#assetstatusquotagendered | AssetStatusQuotaGendered]]''
    * Removed properties
      * ''AssetStatusQuota''
  * ''[[api:building_progress | BUILDING_PROGRESS]]''
    * Added properties
      * ''[[api:BUILDING_PROGRESS#dataestatedecorationlist | DataEstateDecorationList]]''
    * Added functions
      * ''[[api:BUILDING_PROGRESS#unlocktotalbuildingprogress | unlockTotalBuildingProgress]]''
  * ''[[api:character_setup | CHARACTER_SETUP]]''
    * Added properties
      * ''[[api:CHARACTER_SETUP#charactersetupdatagendered | CharacterSetupDataGendered]]''
    * Removed properties
      * ''BeardList''
      * ''FemaleBackList''
      * ''FemaleBeltList''
      * ''FemaleCloakList''
      * ''FemaleClothingModel''
      * ''FemaleFrontList''
      * ''FemaleHairList''
      * ''FemaleHairMaterialList''
      * ''FemaleHatList''
      * ''IdleAnimation''
      * ''LeftHandObject''
      * ''MaleBackList''
      * ''MaleBeltList''
      * ''MaleCloakList''
      * ''MaleClothingModel''
      * ''MaleFrontList''
      * ''MaleHairList''
      * ''MaleHairMaterialList''
      * ''MaleHatList''
      * ''MustacheList''
      * ''RightHandObject''
      * ''WalkAnimation''
  * ''[[api:deceased_villager_data | DECEASED_VILLAGER_DATA]]''
    * Added properties
      * ''[[api:DECEASED_VILLAGER_DATA#gender | Gender]]''
  * ''[[api:game_action_deliver_resource | GAME_ACTION_DELIVER_RESOURCE]]''
    * Added properties
      * ''[[api:GAME_ACTION_DELIVER_RESOURCE#budgetcategory | BudgetCategory]]''
  * ''[[api:game_condition_available_villager_for_promotion | GAME_CONDITION_AVAILABLE_VILLAGER_FOR_PROMOTION]]''
    * Added properties
      * ''[[api:GAME_CONDITION_AVAILABLE_VILLAGER_FOR_PROMOTION#villagerstatusgendertovalidate | VillagerStatusGenderToValidate]]''
    * Removed properties
      * ''AssetStatus''
  * ''[[api:game_condition_population_count | GAME_CONDITION_POPULATION_COUNT]]''
    * Added properties
      * ''[[api:GAME_CONDITION_POPULATION_COUNT#optionalassetprofilegenderlist | OptionalAssetProfileGenderList]]''
    * Removed properties
      * ''OptionalAssetProfileList''
  * ''[[api:game_condition_villager_promoted | GAME_CONDITION_VILLAGER_PROMOTED]]''
    * Added properties
      * ''[[api:GAME_CONDITION_VILLAGER_PROMOTED#genderusage | GenderUsage]]''
    * Renamed properties
      * ''AssetStatus -> [[api:GAME_CONDITION_VILLAGER_PROMOTED#assetvillagerstatustopromoteto | AssetVillagerStatusToPromoteTo]]''
      * ''AssetAgentProfile -> [[api:GAME_CONDITION_VILLAGER_PROMOTED#assetagentprofiletopromotefrom | AssetAgentProfileToPromoteFrom]]''
  * ''[[api:game_condition_villager_status_reached | GAME_CONDITION_VILLAGER_STATUS_REACHED]]''
    * Added properties
      * ''[[api:GAME_CONDITION_VILLAGER_STATUS_REACHED#villagerstatusgendertovalidatelist | VillagerStatusGenderToValidateList]]''
    * Removed properties
      * ''AssetVillagerStatusList''

----

==== Component Classes ====
=== Other changes ===
  * ''[[api:comp_building_manager | COMP_BUILDING_MANAGER]]''
    * Removed functions
      * ''unlockBuildingProgress''
  * ''[[api:comp_building_part | COMP_BUILDING_PART]]''
    * Added events
      * ''[[api:COMP_BUILDING_PART#on_parent_building_changed | ON_PARENT_BUILDING_CHANGED]]''
  * ''[[api:visitor | VISITOR]]''
    * Changed functions
      * ''[[api:VISITOR#setcallbackonclick | setCallbackOnClick]]''

----

==== Enumerations ====
=== Added ===
  * ''[[api:gender_usage | GENDER_USAGE]]''
  * ''[[api:gender_usage_text | GENDER_USAGE_TEXT]]''
  * ''[[api:immigration_probability | IMMIGRATION_PROBABILITY]]''
=== Other changes ===
  * ''[[api:building_part_type | BUILDING_PART_TYPE]]''
    * Added values
      * ''DECORATIVE_ESTATE''
      * ''DECORATIVE_MONUMENT''
      * ''DECORATIVE_DEPRECATED''
      * ''BRIDGE''
  * ''[[api:game_state_flag | GAME_STATE_FLAG]]''
    * Removed values
      * ''BUILDING_STATE_GREAT_HALL''
      * ''BUILDING_STATE_HOSPITITUM''
      * ''BUILDING_STATE_KEEP''
      * ''TAXATION_STATE''

----

===== Assets Changes =====
==== AGENT_PROFILE ====
=== Removed ===
  * ''PROFILE_NUN''

----

==== NOTIFICATION ====
=== Removed ===
  * ''ONBOARDING_NTF''

----

==== VILLAGER_STATUS ====
=== Removed ===
  * ''NUN''
  * ''NUN_NOVICE''
  * ''NUN_PRIORESS''