Changelog

API Changes

Asset Classes

Added

ABSTRACT_QUEST
AGENT_NEED_TYPE
AGENT_NEED_TYPE_LODGING
AGENT_NEED_TYPE_VISIT_BUILDING
ASSET_NARRATIVE_PANEL
ASSET_VICTORY_CONDITION
BUILDING_FUNCTION_INTERACTIVE_LOCATION
BUILDING_FUNCTION_LODGING
CHANGE_EDICT_MANDATE_TYPE
CHANGE_PRIVILEGE_MANDATE_TYPE
EDICT
ESTATE_SETTING
GAME_RULE_MODIFIER_RANGE_PAIR
GAME_RULE_TRADE
GAME_RULE_VICTORY_CONDITION
GUEST
GUEST_REQUIREMENT
OUTCOME_PANEL_DATA
PRIVILEGE
PROGRESS_PATH
PROGRESS_TIER_DATA
PROMOTE_VILLAGER_MANDATE_TYPE
PROMOTION_COST_LIST
QUEST_HOSTING_MISSION
RANGE_FLOAT
SCORE_TRACKER_BEAUTIFICATION_DATA
SCORE_TRACKER_DATA
SCORE_TRACKER_DATA_PROFIT
SCORE_TRACKER_SPLENDOR
SCORE_TRACKER_TERRITORY
SCORE_TRACKER_TRADE_ROUTE
SCORE_TRACKER_VILLAGER_COUNT
SCORE_TRACKER_VILLAGER_STATUS
TAXATION_FUNCTION
TAXATION_FUNCTION_CHURCH
TAXATION_FUNCTION_HOUSING
TAXATION_FUNCTION_MARKET
TAXATION_FUNCTION_RESOURCE_PRODUCTION
TAXATION_SETTINGS
UNLOCKABLE_EDICT
UNLOCKABLE_PRIVILEGE
UNLOCKABLE_TECHNOLOGY
UNLOCK_FUNCTION
UNLOCK_FUNCTION_BUILDING
UNLOCK_FUNCTION_ESTATE_SYSTEM
UNLOCK_FUNCTION_TAXATION
UNLOCK_FUNCTION_TRADE_ROUTE

Removed

BUILDING_FUNCTION_LORD_MANOR
BUILDING_PROGRESS_LIST
GAME_RULE_JOB_STATUS
UNLOCKABLE_ASSIGNABLE_BUILDING_FUNCTION
UNLOCKABLE_BUILDING
UNLOCKABLE_BUILDING_PART_LIST
UNLOCKABLE_TRADE_BONUS
UNLOCKABLE_WALL

Renamed

VILLAGER_NEED_TYPE → AGENT_NEED_TYPE_RESOURCE
- Removed properties
  - DelayAfterUnsuccessfulFill
  - FillDurationInSeconds
  - FillRate
  - GracePeriod
  - HappinessFactor
  - IsUnique
  - NeedTypeDescription
  - NeedTypeName
VILLAGER_PORTRAIT → AGENT_PORTRAIT
MILITARY_QUEST_GENERATOR → MILITARY_CAMPAIGN_SETTINGS
- Added properties
- Removed properties
  - AverageQuestSetupList
  - EasyQuestSetupList
  - HardQuestSetupList
  - MissionDuration
  - RewardGenerator

Other changes

BALANCING
- Added properties
  - DaysBeforeNewcomersLeaving
  - AssetBuilderJobList
  - AssetCommonProgressPath
  - ScoreTrackerList
  - AssetEstateSetting
  - WeaponList
  - BuildingRefundRatio
- Removed properties
  - BuildingProgressList
- Renamed properties
  - TerritoryPrice → TerritoryRegionPrice
  - StartingTileResourceRequirement → StartingRegionResourceRequirement
BUILDING
- Added properties
- Removed properties
  - BuildingPartSetList
  - VillagerRequired
BUILDING_FUNCTION_BAILIFF_OFFICE
- Removed properties
  - BailiffAvailableNotificationData
  - MandateNotificationType
  - MandateTypeList
BUILDING_FUNCTION_CHURCH
- Added properties
  - CapacityMultiplier
  - AssetResourceGenerator
- Removed properties
  - ResourceGeneratorData
BUILDING_FUNCTION_GREAT_HALL
- Added properties
BUILDING_FUNCTION_HOUSE
- Added properties
  - CanUnassignVillager
  - OptionalGenderCompatibility
BUILDING_FUNCTION_KITCHEN
- Added properties
  - ConsumptionHappinessFactor
BUILDING_FUNCTION_MARKET
- Added properties
  - SlotCount
BUILDING_FUNCTION_MONASTERY
- Added properties
  - NunVillagerProfile
  - WorkplaceFunctionPriorityList
BUILDING_FUNCTION_POINT_OF_INTEREST
- Added properties
  - DaysAtDestination
- Removed properties
  - TimeAtDestination
BUILDING_FUNCTION_TAX_OFFICE
- Removed properties
  - DefaultTax
  - TaxableBuildingList
BUILDING_FUNCTION_WORKPLACE
- Added properties
BUILDING_PART
- Added properties
- Removed properties
  - IsOutsideNavigationZone
ESTATE
- Added properties
  - MinInfluence
  - MaxInfluence
  - DualIcon
  - RatingIcon
  - AssetProgressPath
  - DefaultPrivilegeList
  - InfluenceEffectList
  - EstateInfluenceRange
  - AssetBuildingList
- Removed properties
  - EstateProgressList
EVENT
- Added properties
  - IgnoreConditionOnRecurrence
GAME_RULE_STATUS_PROMOTION
- Added properties
  - AssetPromoteVillagerMandateType
- Removed properties
  - NotificationData
  - NotificationType
  - PromotionDurationInDays
  - StatusCostList
  - VillagerProfileOrderingList
HAPPINESS_FACTOR
- Added properties
  - IsHidden
  - HideOnTarget
HELP
- Added properties
  - HelpCondensedHelpItemList
JOB
- Removed properties
  - ProductionDelay
MANDATE_TYPE
- Added properties
  - ButtonTextKey
- Removed properties
  - Workplace
- Added functions
  - updatePossibleMandateList
- Removed functions
  - generatePossibleMandateList
  - init
MASTERPIECE
- Added properties
  - AssetNarrativePanel
  - AssetBuildingPartList
- Removed properties
  - PartSet
  - UnlockNarrativePanelData
- Changed properties type
  - WallToUnlock
MILITARY_CAMPAIGN
- Added properties
- Removed properties
  - MissionDifficultyList
  - QuestGenerator
  - TextList
NOTIFICATION
- Added properties
  - TriggerClickActionOnExpire
QUEST
- Added properties
- Removed properties
  - Description
  - IsSilent
  - Name
  - OnFailCallback
  - OnSuccessCallback
  - QuestFunction
  - QuestListToUnlockAfter
- Renamed properties
  - QuestRewardActionList → QuestSuccessActionList
RESOURCE
- Added properties
  - TradeBuyingPrice
  - TradeSellingPrice
- Removed properties
  - BuyingPrice
  - SellingPrice
  - VillagerBuyingPrice
TRADING_VILLAGE
- Added properties
UNLOCKABLE
- Added properties
  - DataCost
  - ActionList
- Removed properties
  - EstateInfluenceCostList
- Renamed properties
  - PrerequisiteUpgrades → PrerequisiteUnlockableList
VILLAGER_STATUS
- Added properties
  - OptionalAdditionalBehavior
- Renamed properties
  - AssetVillagerNeedList → AssetAgentNeedList
  - AssetVillagerNeedToRemoveList → AssetAgentNeedToRemoveList
- Changed properties type
  - AssetAgentNeedList
  - AssetAgentNeedToRemoveList

Data Classes

Added

Removed

DATA_NARRATIVE_PANEL
ESTATE_PROGRESS_TIER
QUEST_FUNCTION
QUEST_FUNCTION_ASSIGN_BUILDING_FUNCTION
QUEST_FUNCTION_ASSIGN_JOB_ALL_VILLAGERS
QUEST_FUNCTION_ASSIGN_RESOURCE_MARKET
QUEST_FUNCTION_ASSIGN_RESOURCE_TRADE
QUEST_FUNCTION_ASSIGN_RESOURCE_WAREHOUSE
QUEST_FUNCTION_ASSIGN_WORKER
QUEST_FUNCTION_BALANCE
QUEST_FUNCTION_BUILD
QUEST_FUNCTION_BUY_UNLOCKABLE
QUEST_FUNCTION_CITY_STATUS
QUEST_FUNCTION_CONTAINER
QUEST_FUNCTION_DELIVER_RESOURCES
QUEST_FUNCTION_IMMIGRATION
QUEST_FUNCTION_MAX_HAPPINESS
QUEST_FUNCTION_PLACE_BUILDING
QUEST_FUNCTION_PRODUCE_RESOURCE
QUEST_FUNCTION_REACH_VILLAGER_STATUS
QUEST_FUNCTION_SURVIVE_BAD_WEATHER
QUEST_FUNCTION_UNLOCK_TRADE_ROUTE
QUEST_FUNCTION_ZONE

Renamed

QUEST_FUNCTION_SEND_TROOPS → BATTLE_SETTINGS
- Added properties
  - BattleNameKey
  - BattleDescriptionKey
  - QuestFailedActionList
- Removed properties
  - SoldierBackBehavior
  - SoldierJob
  - SoldierLeaveBehavior
  - SoldierRegroupBehavior
EVENT_ACTION_ADD_TRADE_ROUTE → GAME_ACTION_ADD_TRADE_ROUTE
EVENT_ACTION_CHANGE_WEATHER → GAME_ACTION_CHANGE_WEATHER
EVENT_ACTION_PAY → GAME_ACTION_DELIVER_RESOURCE
- Added properties
  - IsDeliveryAction
EVENT_ACTION_GIVE_QUEST → GAME_ACTION_GIVE_QUEST
- Changed properties type
  - Quest
EVENT_ACTION_GIVE_REWARD → GAME_ACTION_GIVE_REWARD
EVENT_ACTION_IGNORE → GAME_ACTION_IGNORE
- Added properties
  - DescriptionKey
EVENT_ACTION_IMMIGRATE → GAME_ACTION_IMMIGRATE
EVENT_ACTION_RANDOM_ACTION → GAME_ACTION_RANDOM_ACTION
- Renamed properties
  - RandomActionList → ActionList
EVENT_ACTION_REMOVE_TRADE_ROUTE → GAME_ACTION_REMOVE_TRADE_ROUTE
ACTION_SHOW_NARRATIVE_PANEL → GAME_ACTION_SHOW_NARRATIVE_PANEL
- Added properties
- Removed properties
  - AssetNotification
  - ChoiceList
  - NarrativePanelData
EVENT_ACTION_TRIGGER_MILITARY_CAMPAIGN → GAME_ACTION_TRIGGER_MILITARY_CAMPAIGN
ACTION_VISIT → GAME_ACTION_VISIT
- Added properties
  - DescriptionKey
  - VisitorStatus
  - VisitorBehaviourTree
  - VisitLeavingAction
  - DaysAtDestination
  - ArrivingWorldGuiIcon
  - ActionWorldGuiIcon
  - VisitorClickAudioKey
- Removed properties
  - TimeAtDestination
- Added events
  - ON_VISITOR_SPAWNED
GAME_CONDITION_SPLENDOR_AMOUNT_REACHED → GAME_CONDITION_BUILDING_SPLENDOR_AMOUNT_REACHED
- Added properties
  - OptionalAssetBuilding
  - NeedToReachWithOneBuilding
- Changed properties type
  - Estate
GAME_CONDITION_QUEST_COMPLETED → GAME_CONDITION_QUEST_STATE
- Added properties
  - QuestList
  - QuestStateBitField
  - AllQuestsHaveState
- Removed properties
  - Quest
GAME_CONDITION_MONTHLY_TRADE_REVENUE → GAME_CONDITION_REVENUE
- Added properties
  - ComparisonOperator
  - Profit
  - BudgetCategoryList
- Removed properties
  - MonthlyRevenue
GAME_RULE_MODIFIER_MONUMENT_SPLENDOR → GAME_RULE_MODIFIER_BUILDING_SPLENDOR
- Added properties
  - ApplyToParentBuilding
GAME_RULE_MODIFIER_DESCRIPTOR_BUILDING_PART → GAME_RULE_MODIFIER_DESCRIPTOR_BUILDABLE

Deprecated

BUILDING_PART_SET

Other changes

AGENT_PROFILE_FUNCTION
- Added properties
  - IsNeedMasteredJobToPromote
BUILDING_PROGRESS
- Added properties
- Removed properties
  - AssetUnlockableBuildingPartList
  - IsManuallyUnlocked
  - VillagerRequired
DELAYED_QUEST
- Changed properties type
  - AssetQuest
EVENT_CALLBACK_TRIGGER_EVENT
- Changed properties type
  - Event
EVENT_CHOICE
- Added properties
  - AdditionalTextKey
  - ConditionList
GAME_ACTION
- Added properties
  - DebugComment
  - Delay
  - IsHidden
- Removed properties
  - Icon
- Added functions
  - getLocalizedName
  - canBeExecuted
  - isHidden
- Removed functions
  - hasTooltipView
GAME_ACTION_APPLY_GAME_RULE
- Added properties
  - OptionalDescriptor
- Removed properties
  - OptionalApplicator
GAME_ACTION_UNLOCK_BUILDING_LIST
- Added properties
  - BuildingProgressData
- Removed properties
  - UnlockName
GAME_CONDITION
- Added properties
  - DebugComment
  - CanConditionBeMetAtStart
  - IsNeedExecution
  - IsOptional
  - IsUsedForTitle
  - IsAReason
  - IsReverseCondition
  - ConditionOnMetAction
GAME_CONDITION_BUILDING_BUILT
- Added properties
  - IsEditingQuest
  - RequiredPartList
  - SpecificAssetPartListRequired
  - BuildingFunctionListRequired
  - IsOwnText
GAME_CONDITION_BUILDING_INVENTORY
- Added properties
  - AssetBuilding
GAME_CONDITION_INFLUENCE_AMOUNT_REACHED
- Added properties
  - ComparisonOperator
GAME_CONDITION_MILITARY_CAMPAIGN_COMPLETED
- Renamed properties
  - MilitaryCampaign → AssetEventMilitaryCampaign
GAME_CONDITION_MULTIPLE_CONDITION
- Added properties
  - IsAny
GAME_CONDITION_PART_OF_BUILDING
- Added properties
  - Building
GAME_CONDITION_VILLAGER_STATUS_REACHED
- Added properties
  - AssetVillagerStatusList
  - Quantity
- Removed properties
  - AssetVillagerStatus
  - NumberRequired
GAME_CONDITION_WOUNDED_COUNT
- Added properties
  - ComparisonOperator
  - CheckTotalSoldierWounded
GAME_RULE_MODIFIER
- Removed properties
  - IsUntilRemoval
GAME_RULE_MODIFIER_DESCRIPTOR_EVENT
- Changed properties type
  - AssetEvent
GAME_RULE_MODIFIER_DESCRIPTOR_RESOURCE_TYPE
- Changed properties type
  - NeedType
GAME_RULE_MODIFIER_DESCRIPTOR_STATUS
- Changed properties type
  - AssetStatus
GAME_RULE_MODIFIER_DESCRIPTOR_UNLOCKABLE
- Changed properties type
  - AssetUnlockable
GAME_RULE_MODIFIER_ESTATE_INFLUENCE
- Changed properties type
  - Estate
GAME_RULE_MODIFIER_NEED_TYPE_DEPLETE_RATE
- Added properties
  - AgentProfile
  - AssetVillagerStatus
- Changed properties type
  - NeedType
GAME_RULE_MODIFIER_TRADE_BONUS
- Added properties
  - TradeBonusType
- Renamed properties
  - BonusRevenuePercentage → BonusPercentage
- Changed properties type
  - EstateAllegianceList
GAME_RULE_MODIFIER_VILLAGER_HAPPINESS
- Added properties
  - HappinessFactorMultiplier
HELP_CATEGORY
- Added properties
  - AssetUnlockFunction
HELP_ITEM
- Added properties
  - AssetUnlockFunction
MANDATE
- Added properties
  - AssignedVillager
  - IsDisabled
- Removed properties
  - Workplace
- Added functions
  - init
  - update
  - startMandate
  - onStartClickCallback
  - getCost
  - addMandateCostModifier
  - removeMandateCostModifier
  - addMandateTimeModifier
  - removeMandateTimeModifier
  - isRequiringBailiff
  - getAssignedVillager
  - setAssignedVillager
  - isDisabled
  - setIsDisabled
- Changed functions
  - initialize
- Added events
  - ON_MANDATE_UPDATED
RESERVED_RESOURCE_ELEMENT
- Added properties
  - IsCurrentlyTransported
- Renamed properties
  - ResourceDepot → DepotResourcesAreComingFrom
RESOURCE_QUANTITY_PAIR
- Removed properties
  - Quantity
  - Resource
RESOURCE_TRADING_INFO
- Removed properties
  - UnitPrice

Data Structures

Other changes

vec2d
- Added functions
  - crossZ
  - cross
  - set
  - normalized
vec2f
- Added functions
  - crossZ
  - cross
  - set
  - normalized
vec2i
- Added functions
  - crossZ
  - cross
  - set
  - normalized
vec3i
- Added functions
  - isZero
  - isNearZero
  - set
  - setXY
  - getOneOrthogonal
  - normalized

Behavior Tree Node Classes

Added

Behavior Tree Data Classes

Added

Other changes

BEHAVIOR_TREE_DATA_LOOP
- Added properties
  - MaximumDuration

Engine Core

Other changes

COMPONENT_MANAGER
- Added functions
  - getAllDisabledComponent
- Changed functions
  - getAllComponent
  - getAllEnabledComponent
GAME_OBJECT
- Added functions
  - isParentedTo
  - forEachComponentReverse
- Removed functions
  - isChildOf
- Changed functions
  - forEachChild
  - forEachChildRecursive
  - forEachComponent
  - getOrCreateComponent
LEVEL
- Added functions
  - getMasterComponentManager
- Removed functions
  - registerRuntimeAsset
  - unregisterRuntimeAsset
- Changed functions
  - pick
  - pickObject
  - pickPosition
- Removed events
  - EVT_UPDATE

Component Classes

Added

Other changes

COMP_AGENT
- Removed properties
  - IsWounded
- Added functions
  - die
COMP_BAILIFF_OFFICE
- Removed functions
  - completeMandate
  - getSelectedMandate
- Removed events
  - ON_MANDATE_LIST_UPDATED
COMP_BUILDING
- Added functions
  - getSubBuildingList
- Added events
- Removed events
  - ON_BUILDING_COMPLETE
  - ON_PREVIEW_UPKEEP_COST_CHANGED
  - ON_SPLENDOR_UPDATE
  - ON_UPKEEP_COST_CHANGED
COMP_BUILDING_ATTACH_NODE
- Added properties
  - MultipleOrientationCount
- Added functions
  - getParentPart
COMP_BUILDING_MANAGER
- Added functions
  - unlockBuildingProgress
- Removed functions
  - getUnlockBuildingListByUnlockName
  - unlockBuildingListByUnlockName
COMP_BUILDING_PART
- Removed properties
  - ConstructionVisual
COMP_IMMIGRATION_MANAGER
- Added properties
  - ImmigrantProfile
  - ImmigrationVisitAction
COMP_MAIN_GAME_LOOP
- Changed events
  - ON_NEW_MONTH
COMP_RESOURCE_DEPOT
- Added properties
  - IsWarehouse
COMP_RESOURCE_GENERATOR
- Added functions
  - getResourceGeneratorData
  - getResourceGenerated
COMP_SOLDIER
- Added functions
  - computeStrength
- Changed functions
  - getStrength
- Added events
  - ON_STRENGTH_UPDATED
COMP_VILLAGER
- Added functions
  - hasJob
  - getDeceasedData
COMP_WORKPLACE
- Added properties
  - ActiveVillagerProductionProgressList
  - CurrentProductionCycleCount
- Removed properties
  - ActivelyWorkingVillagerList
- Added functions
  - destroy
- Removed functions
  - finalize
- Added events
COMP_WORKPLACE_FORESTER
- Added functions
  - allowPlantation
  - unallowPlantation
  - isPlantationAllowed
- Removed functions
  - addPlantable
  - removePlantable
- Changed functions
  - getCurrentPlantableList
COMP_WORKPLACE_KITCHEN
- Changed functions
  - consumeMeal
COMP_WORKPLACE_TAX_OFFICE
- Changed functions
  - depositTaxesCollected

Enumerations

Added

Other changes

MATERIAL_RENDER_MODE
- Added values
  - UNLIT_DECAL
AGENT_ANIMATION
- Added values
  - BENCH_SIT_01
  - BENCH_SIT_02
  - WALK_NUN
BUILDING_ZONE_TYPE
- Added values
  - NAVIGABLE_EXTERIOR
BUILDING_PART_TYPE
- Added values
  - DECORATION
  - OTHER
  - GATEHOUSE
  - INTERACTIVE_LOCATION
  - CROSS
  - PRODUCTION
  - CLOISTER_HALL
  - MARKET_TENT
  - ROOF
  - KEEP
  - TRAINING
  - CHIMNEY
  - BASE
  - PLANT
  - CLOISTER_HALL_ENTRANCE
- Removed values
  - PORTCULLIS
  - SCULPTURE
  - VISITOR_LOCATION
BUDGET_CATEGORY
- Added values
  - TERRITORY_UPKEEP
  - TERRITORY_ACQUISITION
  - MANDATES
  - DONATIONS
- Removed values
  - TERRITORY
INTERACTIVE_LOCATION_PURPOSE
- Added values
  - IMMIGRATION
NOTIFICATION_TYPE
- Added values
  - PROGRESSION
  - OUTCOME_PANEL
  - CELEBRATION
QUEST_STATE
- Removed values
  - IDLE
RESOURCE_TYPE
- Added values
  - MEAL
  - MANUSCRIPTS
  - MONASTIC_MEAL

Foundation - Modding Documentation

User Tools

Site Tools

Sidebar

Table of Contents

Changelog

API Changes

Asset Classes

Added

Removed

Renamed

Other changes

Data Classes

Added

Removed

Renamed

Deprecated

Other changes

Data Structures

Other changes

Behavior Tree Node Classes

Added

Behavior Tree Data Classes

Added

Other changes

Engine Core

Other changes

Component Classes

Added

Other changes

Enumerations

Added

Other changes

Assets Changes

AGENT_NEED_TYPE_RESOURCE

Added

AGENT_PROFILE

Added

Removed

ASSIGNABLE_BUILDING_FUNCTION_LIST

ATLAS_CELL

Added

BEHAVIOR_TREE

Added

BLUEPRINT

Added

BUILDING

Added

BUILDING_FUNCTION_ASSIGNABLE

BUILDING_FUNCTION_CHURCH

Added

BUILDING_FUNCTION_HOUSE

Added

BUILDING_FUNCTION_KITCHEN

Added

BUILDING_FUNCTION_MARKET

Added

BUILDING_FUNCTION_MONASTERY

Added

BUILDING_FUNCTION_RESOURCE_GENERATOR

Added

BUILDING_FUNCTION_TRAINING_SITE

Added

BUILDING_FUNCTION_WORKPLACE

Added

BUILDING_LIST

Added

BUILDING_PART

Added

EVENT

Added

HAPPINESS_FACTOR

Added

INTERACTIVE_LOCATION_SETUP

Added

JOB

Added

MILITARY_CAMPAIGN

Added

Removed