ability

path: common/abilities
fielddescriptionrequiredrhs
nameRequiredLocalisation key
descRequiredLocalisation key
iconOptional<spriteType>
sound_effectOptionalScalar
typeRequiredarmy_leader
costRequiredFloat
durationRequiredInteger
cooldownOptionalInteger
cancelableOptionalyes/no
allowedRequiredtrigger block
unit_modifiersOptionalblock, containing:
Requiredmodifier fields
Requiredunit_stat fields
one_time_effectOptionaleffect block
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Recommended, manymodifier_rule fields

ace

path: common/aces
fielddescriptionrequiredrhs
typeRequiredair_transport, cas, fighter, interceptor, missile, naval_bomber, scout_plane, strategic_bomber, suicide, tactical_bomber
chanceRequiredFloat
typeRequiredblock, containing:
air_transport, cas, fighter, interceptor, missile, naval_bomber, scout_plane, strategic_bomber, suicide, tactical_bomberRecommended, many
effectRequiredmodifier block, with scopes ROOT: Air

adjaceny_rule

path: map
fielddescriptionrequiredrhs
nameRequiredLocalisation key
iconRequiredInteger
contestedRequiredblock, containing:
armyRequiredyes/no
navyRequiredyes/no
submarineRequiredyes/no
tradeRequiredyes/no
enemyRequiredblock, containing:
armyRequiredyes/no
navyRequiredyes/no
submarineRequiredyes/no
tradeRequiredyes/no
friendRequiredblock, containing:
armyRequiredyes/no
navyRequiredyes/no
submarineRequiredyes/no
tradeRequiredyes/no
neutralRequiredblock, containing:
armyRequiredyes/no
navyRequiredyes/no
submarineRequiredyes/no
tradeRequiredyes/no
required_provincesRequiredblock, containing:
Required, up to 10
offsetRequiredblock, containing:
IntegerRequired min 3, up to 3
is_disabledOptionalblock, containing:
Requiredtrigger fields
tooltipRequiredLocalisation key

ai_area

path: common/ai_areas
fielddescriptionrequiredrhs
continentsOptionalblock, containing:
Required, many
strategic_regionsOptionalblock, containing:
<strategic_region>Recommended, many

ai_equipment_design_group

path: common/ai_equipment
fielddescriptionrequiredrhs
category Only category = naval is currently supported, starting with version 1.6.0.Requirednaval
blocked_for Exclusionary list of countries that will not use this design group.Optionalblock, containing:
Recommended, many
available_for Inclusionary list of countries that will use this design group. If this list is empty, all countries not in the block list will be allowed. If this list is not empty, only countries that are in this list and not in the blocked list will be allowed.Optionalblock, containing:
Recommended, many
roles List of roles that this design group can be used for. AI will attempt to design and produce equipment to satisfy all roles that it can. So it will try to actively use one design per role for new production and upgrading/refitting. Roles here are dynamically generated and should work with role_ratio.Requiredblock, containing:
Scalar, a "ai_roles" valueRequired
priority Base priority for creating a design in this group or for creating or upgrading equipment to use one of these designs. A higher number means higher priority.Requiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
<ai_equipment_design> of subtype design One or more specifications of designs belonging to this design group.Required, manyblock, containing:
role_icon_indexOptionalInteger
priority Further priority for creating this design specifically or for creating or upgrading equipment to use this design.Requiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
enable List of triggers that must all be true for the design to be usable; true by default if empty or missing.Optionaltrigger block
target_variant Specifications about how a matching equipment variant should be designed.Optionalblock, containing:
match_value An additional weight indicating how much the particular design is worth, if it matches.RequiredFloat
type The equipment archetype or equipment type that the variant must use to match.Required<equipment>
modules The matching requirements on individual module slots.Requiredblock, containing:
A slot can be assigned a module category. Any other module category fails the match. When designing an equipment variant, the latest available will be favored.Optional, many
A slot can be assigned a specific module. Any other module fails the match. Less than and greater than comparisons can be used to force lesser or greater modules within a chain of module upgrades. When designing an equipment variant, the earliest module will be favored for the lesser restriction, and the latest will be favored for the greater restriction.Optional, many<module>
A slot can be assigned empty. Any module of any kind fails the match. A slot can be greater than empty. Only an empty slot fails the match.Optional, manyempty
A slot can refer to a nested group of more detailed requirements. If you provide multiple instances of module attributes or any_of attributes, then only one must match for the match to succeed.Optional, manyblock, containing:
module You can specify a module category, or an equal, lesser, or greater module, or empty/non-empty.Optional, many
moduleOptional, many<module>
moduleOptional, manyempty
upgrade Optionally, for upgrading existing equipment to a this design, you can require that this slot must have a better module in order to use this design. Example upgrade > current. Alternatively, you can require that it must use exactly the same module that is already on the existing equipment. Example upgrade = current.Optionalcurrent
any_ofOptional, manyblock, containing:
<module>Optional, many
Optional, many
requirements List of hard requirements that all must match for this design to be usable. These follow the same pattern as a slot entry above within target_variant = { modules = { ... } }, but without being tied to an individual slot.Optionalblock, containing:
moduleOptional, many
moduleOptional, many<module>
allowed_modules Additional modules that are allowed in any available slots for any of the above designs, after all requirements are fulfilled. Modules at the top of this list are favored over those at the bottom. Modules not in this list will not be used in any remaining open slots.Optionalblock, containing:
<module>Optional, many
Optional, many

ai_focus

(+) Subtypes

path: common/ai_focuses
fielddescriptionrequiredrhs
research of subtype researchRequiredblock, containing:
defensive, offensive, carrier, battleship, cruiserOptional, manyFloat
Optional, manyFloat
ai_national_focuses of subtype national_focusesRequiredblock, containing:
<focus>Optional, many
<shared_focus>Optional, many

ai_peace

path: common/ai_peace
fielddescriptionrequiredrhs
annex_randomnessRequiredInteger
liberate_randomnessRequiredInteger
puppet_randomnessRequiredInteger
take_states_randomnessRequiredInteger
force_government_randomnessRequiredInteger
enableRequiredtrigger block
build_temp_varsOptionaltrigger block
annexRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
liberateRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
puppetRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
puppet_allRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
puppet_stateRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
take_statesRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
force_governmentRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

ai_strategy

path: common/ai_strategy
fielddescriptionrequiredrhs
target_arrayOptionalA "array" value
target_arrayOptional64 bit Float or float variable
abort_when_not_enabledOptionalyes/no
reversedOptionalyes/no
Requiredai_strategy_rule fields
allowedOptionaltrigger block
targetsOptionalblock, containing:
Scope object in [Country] scopeRecommended, many
enable_reverseOptionaltrigger block
enableRequiredtrigger block
abortOptionaltrigger block

ai_strategy_plan

path: common/ai_strategy_plans
fielddescriptionrequiredrhs
nameRequiredLocalisation key
descOptionalLocalisation key
Requiredai_strategy_rule fields
allowedOptionaltrigger block
enableRequiredtrigger block
abortOptionaltrigger block
ai_national_focusesOptionalblock, containing:
<focus>Optional, many
<shared_focus>Optional, many
focus_factorsOptionalblock, containing:
<focus>Optional, manyInteger
<shared_focus>Optional, manyInteger
researchOptionalblock, containing:
Recommended, manyFloat
ideasOptionalblock, containing:
Recommended, manyInteger
traitsOptionalblock, containing:
<country_leader_trait>Recommended, manyInteger
weight Keep small, as it is used as a factor for some things (such as research needs). Recommended around 1.0. Useful for relation between plans.Optionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

ai_template

path: common/ai_templates
fielddescriptionrequiredrhs
match_to_countRequiredFloat
rolesRequiredblock, containing:
Scalar, a "ai_roles" valueRecommended, many
available_forOptionalblock, containing:
Recommended, many
blocked_forOptionalblock, containing:
Recommended, many
upgrade_prioRequiredblock, containing:
base, factorRequiredFloat
Requiredmodifier_rule fields
ScalarRequired, up to 10block, containing:
custom_iconOptionalInteger
reinforce_prioOptionalInteger
target_widthRequiredFloat
width_weightRequiredFloat
column_swap_factorRequiredFloat
replace_at_matchOptionalFloat
replace_withOptional
target_min_matchOptionalFloat
upgrade_prioRequiredblock, containing:
base, factorRequiredFloat
Requiredmodifier_rule fields
production_prioOptionalblock, containing:
base, factorRequiredFloat
Requiredmodifier_rule fields
can_upgrade_in_fieldOptionaltrigger block
enable List of triggers that must all be true for the template to be usable; true by default if empty or missing.Optionaltrigger block
stat_weightsOptionalblock, containing:
FloatRequired min 33, up to 33
target_templateRequiredblock, containing:
weightRequiredFloat
match_valueRequiredFloat
regimentsRequiredblock, containing:
<unit>Required, up to 25Integer
supportOptionalblock, containing:
<unit>Optional, up to 5Integer
allowed_typesRequiredblock, containing:
<unit>Recommended, many

airports

path: map
fielddescriptionrequiredrhs
<state>Required, manyblock, containing:
Required

autonomy

path: common/autonomous_states
fielddescriptionrequiredrhs
idRequiredLocalisation key
defaultOptionalyes/no
is_puppetOptionalyes/no
use_overlord_colorOptionalyes/no
min_freedom_levelRequiredFloat between 0 and 0.99
peace_conference_initial_freedomOptionalFloat between 0 and 1
manpower_influenceRequiredFloat between 0 and 1
ruleRequiredblock, containing:
can_be_called_to_war, can_be_spymaster, can_boost_other_ideologies, can_create_collaboration_government, can_create_factions, can_declare_war_on_same_ideology, can_declare_war_without_wargoal_when_in_war, can_decline_call_to_war, can_force_government, can_generate_female_aces, can_guarantee_other_ideologies, can_join_factions, can_join_factions_not_allowed_diplomacy, can_join_opposite_factions, can_lower_tension, can_not_declare_war, can_occupy_non_war, can_only_justify_war_on_threat_country, can_puppet, can_send_volunteers, can_use_kamikaze_pilots, contributes_operatives, units_deployed_to_overlord, can_boost_own_ideologyOptional, up to 20yes/no
modifierRequiredmodifier block
ai_subject_wants_higherRequiredblock, containing:
factorRequiredFloat
ai_overlord_wants_lowerRequiredblock, containing:
factorRequiredFloat
ai_overlord_wants_garrisonOptionaltrigger block
allowedRequiredtrigger block
allowed_levels_filterOptionalblock, containing:
<autonomy>Required
use_for_peace_conference_weightOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
can_take_levelOptionaltrigger block
can_lose_levelOptionaltrigger block

bookmark

path: common/bookmarks
fielddescriptionrequiredrhs
nameRequiredLocalisation key
descRequiredLocalisation key
dateRequiredDate with YYYY.MM.dd format, starting from 1.1.1
pictureRequiredScalar
default_countryRequired
defaultOptionalyes/no
Required min 7, up to 10000block, containing:
minorOptionalyes
historyRequiredLocalisation key
ideologyRequired<ideology>
availableOptionaltrigger block
ideasOptionalblock, containing:
Recommended, many
focusesOptionalblock, containing:
<focus>Optional, up to 3
<shared_focus>Optional, up to 3
---Optionalblock, containing:
historyRequiredLocalisation key
effectRequiredblock, containing:
randomize_weatherRequired12345
randomize_weatherRequired22345

building

(+) Subtypes

path: common/building
fielddescriptionrequiredrhs
base_costRequiredInteger
base_cost_conversionOptionalInteger
per_level_extra_costOptionalInteger
max_levelOptionalInteger
valueRequiredInteger
icon_frameRequiredInteger
show_on_mapOptionalInteger
show_on_map_meshesOptionalInteger
always_shownOptionalyes/no
has_destroyed_meshOptionalyes/no
shares_slotsOptionalyes/no
infrastructure_construction_effectOptionalyes/no
provincialOptionalyes/no
damage_factorOptionalFloat
only_costal Yes, they spelled it costal.Optionalyes/no
disabled_in_dmzOptionalyes/no
infrastructureOptionalyes/no
air_baseOptionalyes/no
is_portOptionalyes/no
anti_airOptionalyes/no
refineryOptionalyes
radarOptionalyes/no
nuclear_reactorOptionalyes/no
military_productionOptionalFloat
general_productionOptionalFloat
naval_productionOptionalFloat
land_fortOptionalInteger
naval_fortOptionalInteger
rocket_productionOptionalInteger
rocket_launch_capacityOptionalInteger
air_defenceOptionalInteger
show_modifierOptionalyes
max_fuel_buildingOptionalFloat
fuel_siloOptionalyes
fuel_gain_from_statesOptionalFloat
Requiredmodifier fields

combat_tactic

(+) Subtypes

path: common
fielddescriptionrequiredrhs
is_attackerRequiredyes/no
activeOptionalyes/no
pictureRequiredScalar
countered_byOptional<combat_tactic>
phaseOptionalno, close_combat, tactical_withdrawal, seize_bridge, hold_bridge
display_phaseOptionalno, close_combat, tactical_withdrawal, seize_bridge, hold_bridge
attacker, defenderRequired, up to 2Float
attacker_movement_speedOptionalFloat
Requiredunit_stat fields
triggerRequiredblock, containing:
is_attackerRequiredyes/no
phaseRequiredno, close_combat, tactical_withdrawal, seize_bridge, hold_bridge
Requiredtrigger fields
baseRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

containerWindowType

path: interface
fielddescriptionrequiredrhs
nameRequiredScalar
moveable Mouse DraggableOptionalyes/no
orientation Origin of position fieldOptionalCENTER, CENTER_LEFT, CENTER_RIGHT, UPPER_LEFT, LOWER_LEFT, UPPER_RIGHT, LOWER_RIGHT, RIGHT, LEFT, CENTER_UP, CENTER_DOWN, CENTER_LOWER, UP, DOWN
clipping Will remove elements outside of size bounding boxOptionalyes/no
fullscreenOptionalyes/no
Requiredgui fields
Requiredgui_standard fields
Requiredgui_animation fields
Requiredgui_sound fields
verticalScrollbarOptional
horizontalScrollbarOptional
click_to_frontAllows clicking to reorder windowsOptionalyes/no
smooth_scrollingSmoothly scroll a scrollbar -- container versionOptionalyes/no
scroll_wheel_factorOptionalFloat
background Background textureOptional, manyblock, containing:
nameOptionalScalar
Requiredgui_standard fields
Requiredgui_image fields
Requiredgui_sound fields
Requiredgui_localization fields
drag_scrollOptionalblock, containing:
left, middle, rightOptional, many

country_file

(+) Subtypes

path: common/countries
fielddescriptionrequiredrhs
graphical_culture of subtype countryOptional, manyScalar
graphical_culture_2d of subtype countryOptional, manyScalar
color of subtype countryRequiredblock, containing:
IntegerRequired min 3, up to 3
color of subtype countryRequiredblock, containing:
FloatRequired min 3, up to 3
ScalarRequired, manyblock, containing:
color of subtype cosmeticRequiredblock, containing:
IntegerRequired min 3, up to 3
color of subtype cosmeticRequiredblock, containing:
FloatRequired min 3, up to 3
color_ui of subtype cosmeticOptionalblock, containing:
IntegerRequired min 3, up to 3
color_ui of subtype cosmeticOptionalblock, containing:
FloatRequired min 3, up to 3

country_history

path: history/countries
fielddescriptionrequiredrhs
capitalRequired<state>
oobOptional<oob>
Requiredeffect fields
Date with YYYY.MM.dd format, starting from 1.1.1Optional, manyblock, containing:
capitalOptional<state>
oobOptional, many<oob>
Requiredeffect fields

country_leader_trait

path: common/country_leader
fielddescriptionrequiredrhs
nameOptionalLocalisation key
randomOptionalyes/no
spriteOptionalInteger
Requiredmodifier fields
Optional, up to 100ai_strategy_rule fields
Optional, manytargeted_modifier_rule fields
Requiredai_strategy_rule fields
equipment_bonusOptionalblock, containing:
<equipment>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_planeOptional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
<unit>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

country_scorer

path: common/scorers/country
fielddescriptionrequiredrhs
targetsRequiredblock, containing:
targets_dynamicOptionalyes/no
target_non_existingOptionalyes/no
target_arrayOptional, manyA "array" value
target_arrayOptional, many64 bit Float or float variable
targetsOptionalblock, containing:
Optional, many
A "variable" valueOptional, many
64 bit Float or float variableOptional, many
target_root_trigger the country initiating the mission has to pass this triggerOptionaltrigger block, with scopes ROOT: Country
target_trigger each target among the selected ones has to pass this triggerOptionaltrigger block, with scopes ROOT: Country, FROM: Country
score MTTH like score description. THIS is a target. FROM is the initiator.Recommendedblock, containing:
base, factorRequired64 bit Float or float variable
Requiredmodifier_rule fields

country_tag_alias

(+) Subtypes

path: common/country_tag_aliases
fielddescriptionrequiredrhs
variable of subtype variableRequired64 bit Float or float variable
global_event_target of subtype global_event_targetRequiredA "global_event_target" value
ScalarRequiredA "event_target" value
original_tag of subtype triggeredOptional
target_array of subtype triggeredOptionalA "array" value
target_array of subtype triggeredOptional64 bit Float or float variable
fallback of subtype triggeredOptional
Optional, manytrigger fields
targets of subtype triggeredOptionalblock, containing:
Optional, many
A "variable" valueOptional, many
64 bit Float or float variableOptional, many
country_score of subtype triggeredOptionalblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields

critical_part

path: common/units/critical_parts
fielddescriptionrequiredrhs
iconRequired<spriteType>
frameRequiredInteger
str_damageOptionalFloat
org_damageOptionalFloat
str_damage_multiplierOptionalFloat
org_damage_multiplierOptionalFloat
chanceOptionalFloat
base_damage_instanceOptionalFloat
damage_instance_per_added_moduleOptionalFloat
max_damage_instanceOptionalFloat
stat_penaltiesOptionalnaval_stat block
modifierOptionalnaval_stat block

decision

(+) Subtypes

path: common/decisions
fielddescriptionrequiredrhs
iconOptionalScalar
priorityOptionalInteger
nameOptionalLocalisation key
descOptionalLocalisation key
fire_only_onceOptionalyes/no
cancel_if_not_visibleOptionalyes/no
costOptional64 bit Integer or integer variable
highlight_color_before_activeOptionalInteger
highlight_color_while_activeOptionalInteger
war_with_on_remove, war_with_on_complete, war_with_on_timeoutOptional, manyScope object in [Country] scope
war_with_on_remove, war_with_on_complete, war_with_on_timeoutOptional, many
war_with_target_on_remove, war_with_target_on_complete, war_with_target_on_timeoutOptional, manyyes/no
days_re_enableOptionalInteger
fixed_random_seedOptionalyes/no
on_map_modeOptionalmap_only, map_and_decisions_view
iconOptional, manyblock, containing:
keyRequiredScalar
triggerRequiredtrigger block
priorityOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
available of subtype country Check if this decision can be activated.Optionaltrigger block, with scopes ROOT: Country, FROM: Country
visible of subtype country Can the player see this decision.Optionaltrigger block, with scopes ROOT: Country, FROM: Country
complete_effect of subtype countryOptionaleffect block, with scopes ROOT: Country, FROM: Country
remove_effect of subtype countryOptionaleffect block, with scopes ROOT: Country, FROM: Country
cancel_effect of subtype countryOptionaleffect block, with scopes ROOT: Country, FROM: Country
ai_will_do of subtype countryOptionalblock, containing:
base, factorRequired64 bit Float or float variable
Requiredmodifier_rule fields
allowed Who can use this decision.Optionaltrigger block, with scopes ROOT: Country
custom_cost_text of subtype custom_costRequiredLocalisation key
custom_cost_trigger of subtype custom_costRequiredtrigger block, with scopes ROOT: Country
highlight_statesOptionaltrigger block, with scopes ROOT: Country
highlight_state_targetsOptionalblock, containing:
stateRecommended, many<state>
stateRecommended, many64 bit Float or float variable
highlight_provincesOptionalblock, containing:
Recommended, many
days_remove of subtype timedOptional64 bit Float or float variable
Optional, manytargeted_modifier_rule fields
cancel_trigger of subtype timedOptionaltrigger block, with scopes ROOT: Country, FROM: Country
remove_trigger of subtype timedOptionaltrigger block, with scopes ROOT: Country, FROM: Country
modifier of subtype timedOptionalmodifier block, with scopes ROOT: Country, FROM: Country
is_good of subtype missionRequiredyes/no
days_mission_timeout of subtype missionRequired64 bit Integer or integer variable
selectable_mission of subtype mission Can select this mission like a regular decision.Optionalyes/no
activation of subtype missionRequiredtrigger block, with scopes ROOT: Country, FROM: Country
timeout_effect of subtype missionOptionaleffect block, with scopes ROOT: Country, FROM: Country
cancel_trigger of subtype missionOptionaltrigger block, with scopes ROOT: Country, FROM: Country
is_good of subtype state_missionRequiredyes/no
days_mission_timeout of subtype state_missionRequired64 bit Integer or integer variable
selectable_mission of subtype state_mission Can select this mission like a regular decision.Optionalyes/no
activation of subtype state_missionRequiredtrigger block, with scopes ROOT: Country, FROM: State
timeout_effect of subtype state_missionOptionaleffect block, with scopes ROOT: Country, FROM: State
cancel_trigger of subtype state_missionOptionaltrigger block, with scopes ROOT: Country, FROM: State
targets_dynamic of subtype targetedOptionalyes/no
Optional, manytargeted_modifier_rule fields
target_array of subtype targetedOptional, manyA "array" value
target_array of subtype targetedOptional, many64 bit Float or float variable
target_non_existing of subtype targetedOptionalyes/no
target_trigger of subtype targetedOptionaltrigger block, with scopes ROOT: Country, FROM: Country
targets of subtype targetedOptionalblock, containing:
Scope object in [Country] scopeOptional, many
Optional, many
A "variable" valueOptional, many
64 bit Float or float variableOptional, many
target_root_trigger of subtype targetedOptionaltrigger block, with scopes ROOT: Country
highlight_states of subtype targetedOptionaltrigger block, with scopes ROOT: Country, FROM: Country
state_target of subtype state_targetedRequiredyes
Optional, manytargeted_modifier_rule fields
target_array of subtype state_targetedOptional, manyA "array" value
target_array of subtype state_targetedOptional, many64 bit Float or float variable
visible of subtype state_targeted Can the player see this decision.Optionaltrigger block, with scopes ROOT: Country, FROM: State
available of subtype state_targeted Check if this decision can be activated.Optionaltrigger block, with scopes ROOT: Country, FROM: State
cancel_trigger of subtype state_targetedOptionaltrigger block, with scopes ROOT: Country, FROM: State
complete_effect of subtype state_targetedOptionaleffect block, with scopes ROOT: Country, FROM: State
remove_effect of subtype state_targetedOptionaleffect block, with scopes ROOT: Country, FROM: State
cancel_effect of subtype state_targetedOptionaleffect block, with scopes ROOT: Country, FROM: State
target_trigger of subtype state_targetedOptionaltrigger block, with scopes ROOT: Country, FROM: State
targets of subtype state_targetedOptionalblock, containing:
<state>Optional, many
A "variable" valueOptional, many
64 bit Float or float variableOptional, many
target_root_trigger of subtype state_targetedOptionaltrigger block, with scopes ROOT: Country
ai_will_do of subtype state_targetedOptionalblock, containing:
base, factorRequired64 bit Float or float variable
Requiredmodifier_rule fields

decision_category

path: common/decisions/categories
fielddescriptionrequiredrhs
iconOptionalScalar
pictureOptionalScalar
priorityOptionalInteger
visible_when_emptyOptionalyes/no
visibility_typeOptionalmap_only, map_and_decisions_view
scripted_guiOptional<scripted_gui>
iconOptional, manyblock, containing:
keyRequiredScalar
triggerRequiredtrigger block
priorityOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
available Check if decisions in this category can be activated.Optionaltrigger block, with scopes ROOT: Country
allowed Check if who can use decisions in this category.Optionaltrigger block, with scopes ROOT: Country
visible Can the player see decisions in this category.Optionaltrigger block, with scopes ROOT: Country
cancel_trigger Check whether to cancel missions in this category.Optionaltrigger block, with scopes ROOT: Country
custom_iconOptional, manyblock, containing:
tagRequired
valueRequiredScalar
descRequiredLocalisation key
visibleRequiredtrigger block
on_map_areaOptional, manyblock, containing:
nameRequiredLocalisation key
zoomRequiredInteger
stateOptional<state>
target_arrayOptional, manyA "array" value
target_arrayOptional, many64 bit Float or float variable
targetsOptionalblock, containing:
<state>Optional, many
target_triggerOptionaltrigger block, with scopes ROOT: Country, FROM: State
target_root_triggerOptionaltrigger block, with scopes ROOT: Country

division_name

path: common/units/names_divisions
fielddescriptionrequiredrhs
nameRequiredInline localisation key
fallback_nameOptionalScalar
for_countriesRequiredblock, containing:
Recommended, many
can_useOptionaltrigger block
division_typesOptionalblock, containing:
<unit> of subtype land_unitRecommended, many
link_numbering_withOptionalblock, containing:
<division_name>Recommended, many
unorderedOptionalblock, containing:
IntegerRecommended, manyblock, containing:
ScalarRequired
orderedOptionalblock, containing:
IntegerRecommended, manyblock, containing:
ScalarRequired

dynamic_modifier

path: common/dynamic_modifiers
fielddescriptionrequiredrhs
icon Optional, will show up in guis if icon is specified.Optional<spriteType>
Optional, many64 bit Float or float variable
enable Optional, the modifier won't apply if not enabled.Optionaltrigger block
remove_trigger Optional, will remove the modifier if true.Optionaltrigger block

entity

path: gfx
fielddescriptionrequiredrhs
nameRequiredScalar
pdxmeshOptional<pdxmesh>
pdxmeshOptionalempty_mesh
cull_radiusOptionalFloat
scaleOptionalFloat
default_stateOptional
default_stateOptionalno_state
get_state_from_parentOptionalyes/no
cloneOptional<entity>
locatorOptional, manyblock, containing:
nameRequiredScalar
positionRequiredblock, containing:
FloatRequired min 3, up to 3
rotationOptionalblock, containing:
FloatRequired min 3, up to 3
stateOptional, manyblock, containing:
nameRequiredScalar
state_timeOptionalFloat
next_stateOptional
animationOptional
animation_speedOptionalFloat
animation_blend_timeOptionalFloat
loopingOptionalyes/no
chanceOptionalFloat
time_offsetOptionalblock, containing:
FloatRequired min 2, up to 2
propagate_stateOptional, manyblock, containing:
Required
game_dataOptionalblock, containing:
hitmiss_effectOptional, manyblock, containing:
timeRequiredFloat
typeRequiredbig, small
eventOptional, manyblock, containing:
idOptionala_1_bomb, a_1_crash, a_1_fire, a_1_fire, a_1_idle, a_1_idle, a_1_supply, a_2_bomb, a_2_crash, a_2_fire, a_2_fire, a_2_idle, a_2_idle, a_2_supply, a_3_bomb, a_3_crash, a_3_fire, a_3_idle, a_3_idle, a_3_supply, a_bomb, a_crash, a_explode, a_fire, a_fire, a_idle, a_idle, a_supply, d_1_crash, d_1_crash, d_1_fire, d_1_idle, d_2_crash, d_2_fire, d_2_fire, d_2_idle, d_2_idle, d_3_crash, d_3_fire, d_3_idle, d_bomb, d_crash, d_crash, d_fire, d_idle, d_idle
trigger_onceOptionalyes/no
nodeOptionalScalar
entityOptional<entity>
lifeOptionalFloat
timeOptionalFloat
particleOptional<pdxparticle>
keep_particleOptionalyes/no
lightOptional<light>
soundOptionalblock, containing:
soundeffectRequiredScalar
attachOptional, manyblock, containing:
nameRequiredScalar
ScalarRequired min 2, up to 2<entity>
game_dataOptionalblock, containing:
texture_anim_speedOptionalFloat

equipment

(+) Subtypes

path: common/units/equipment
fielddescriptionrequiredrhs
year Limits the equipment from appearing before the specified year. Optional.OptionalInteger
is_archetype Specifies an entry as an archetype entry. All non-archetype entries inherit.Optionalyes/no
is_buildable Prevents this equipment from being built.Optionalyes/no
is_convertableOptionalyes/no
active Determines if this equipment is available without unlocking from a technology.Optionalyes/no
can_licenseOptionalyes/no
spriteOptionalScalar
aliasOptional<unit>
interface_category Which category the equipment appears in the production screen.Optionalinterface_category_land, interface_category_armor, interface_category_capital_ships, interface_category_screen_ships, interface_category_other_ships, interface_category_air
priority Priority for usage over other equipment.OptionalInteger
type Internal type: what kind of unit can use this equipment.Optionalinfantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_plane
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
offensive_weaponsOptionalyes/no
priorityOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
picture of subtype archetype_equip GFX reference used to define equipment picture in land-lease.RequiredScalar
group_by of subtype archetype_equip How the equipment is grouped in the production screen.Requiredarchetype, type
family of subtype archetype_equipOptional<equipment> of subtype archetype_equip
interface_category of subtype archetype_equipRequiredinterface_category_land, interface_category_armor, interface_category_capital_ships, interface_category_screen_ships, interface_category_other_ships, interface_category_air
can_be_produced of subtype archetype_equipOptionaltrigger block, with scopes ROOT: Country
carrier_capable of subtype air_equipOptionalyes
air_map_icon_frame of subtype air_equipRequiredInteger
interface_overview_category_index of subtype air_equipRequiredInteger
archetype of subtype regular_equip Which archetype equipment this equipment inherits from.Required<equipment> of subtype archetype_equip
parent of subtype regular_equip Which equipment is parent to this equipment (i.e. which does it supercede).Optional<equipment> of subtype regular_equip
visual_level of subtype regular_equip Image priority in production screen.OptionalInteger
one_use_only of subtype regular_equipOptionalyes/no
family of subtype regular_equipOptional<equipment> of subtype regular_equip
can_convert_from of subtype regular_equipOptionalblock, containing:
<equipment> of subtype regular_equipRequired, up to 5
visual_tech_level_addition of subtype naval_equipOptionalInteger
model of subtype naval_equipOptionalScalar
module_slots of subtype naval_equip All parent module slots will directly inherited with no modifications.Optionalinherit
module_slots of subtype naval_equip List of module slots and their details.Optionalblock, containing:
Optional, many
Optional, manyinherit
Optional, manyblock, containing:
required of subtype naval_equipRequiredyes/no
gfx of subtype naval_equipOptionalScalar
allowed_module_categories of subtype naval_equipRequiredblock, containing:
Required, many
module_count_limit of subtype naval_equip Any number of module count limits can be specified. They are automatically inherited by child equipment types. An inherited limit is overridden if the child has a limit with exactly the same match conditions.Optional, manyblock, containing:
category of subtype naval_equipOptional
module of subtype naval_equipOptional<module>
count of subtype naval_equipRequiredInteger
default_modules of subtype naval_equip List of modules assigned to module slots for the default equipment variant for this type.Requiredblock, containing:
Optional, many<module>
Optional, manyempty
type Internal type: what kind of unit can use this equipment.Optionalblock, containing:
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_planeRequired, many
resources Resources needed for producing one unit of the equipment..Optionalblock, containing:
<resource>Recommended, manyInteger
upgrades List of upgrade names.Optional, up to 3block, containing:
<upgrade>Recommended, up to 4

event

(+) Subtypes

path: events
fielddescriptionrequiredrhs
idRequiredScalar
titleOptional, manyLocalisation key
pictureOptional<spriteType>
descOptional, manyLocalisation key
hiddenOptionalyes
hiddenOptionalno
majorOptionalyes
majorOptionalno
fire_only_onceOptionalyes
fire_only_onceOptionalno
is_triggered_onlyOptionalyes
is_triggered_onlyOptionalno
timeout_daysOptionalInteger
fire_for_senderOptionalyes/no
titleOptional, manyblock, containing:
textRequiredLocalisation key
triggerRecommendedtrigger block
descOptional, manyblock, containing:
textRequiredLocalisation key
triggerRecommendedtrigger block
triggerOptionaltrigger block
show_majorOptionaltrigger block
mean_time_to_happenOptionalblock, containing:
daysOptionalInteger
monthsOptionalInteger
yearsOptionalInteger
Requiredmodifier_rule fields
immediateOptional, manyeffect block
optionOptional, manyblock, containing:
nameOptionalLocalisation key
Requiredeffect fields
triggerOptionaltrigger block
ai_chanceOptionalblock, containing:
base, factorOptional, many64 bit Float or float variable
Requiredmodifier_rule fields

focus_tree

path: common/national_focus
fielddescriptionrequiredrhs
idRequiredLocalisation key
defaultOptionalyes/no
reset_on_civilwarOptionalyes/no
shared_focusOptional, many<shared_focus>
countryRequiredblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
continuous_focus_positionRecommendedblock, containing:
xRequiredInteger
yRequiredInteger
initial_show_positionOptionalblock, containing:
focusOptional<focus>
focusOptional<shared_focus>
xOptionalInteger
yOptionalInteger
offsetOptional, manyblock, containing:
xOptionalInteger
yOptionalInteger
triggerRequiredtrigger block
focusOptional, manyblock, containing:
idRequiredLocalisation key
textOptionalLocalisation key
iconRecommended<spriteType>
costRequiredFloat
xRequiredInteger
yRequiredInteger
relative_position_idOptional<focus>
relative_position_idOptional<shared_focus>
dynamic Used for focuses that can change title/desc.Optionalyes
dynamicOptionalno
available_if_capitulatedOptionalyes
available_if_capitulatedOptionalno
cancel_if_invalidOptionalno
cancel_if_invalidOptionalyes
continue_if_invalidOptionalyes
continue_if_invalidOptionalno
cancelableOptionalno
cancelableOptionalyes
bypass_if_unavailableOptionalyes
bypass_if_unavailableOptionalno
will_lead_to_war_withOptional, manyScope object in [Country] scope
will_lead_to_war_withOptional, many
offsetOptional, manyblock, containing:
xOptionalInteger
yOptionalInteger
triggerOptionaltrigger block
prerequisiteOptional, manyblock, containing:
focusOptional, many<focus>
focusOptional, many<shared_focus>
mutually_exclusiveOptional, manyblock, containing:
focusOptional, many<focus>
focusOptional, many<shared_focus>
bypassOptionaltrigger block
allow_branchOptionaltrigger block
availableOptionaltrigger block
cancelOptionaltrigger block
historical_aiOptionaltrigger block
select_effectOptionaleffect block
complete_tooltipOptionaleffect block
completion_rewardRecommendedeffect block
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
search_filtersOptionalblock, containing:
Scalar, a "focus_filter" valueRecommended, many

game_rule

path: common/game_rules
fielddescriptionrequiredrhs
nameRequiredLocalisation key
required_dlcOptionalPoland: United and Ready, Together for Victory, Death or Dishonor, Waking the Tiger, Man the Guns, La Resistance, Battle for the Bosporus
descOptionalLocalisation key
group Used for filtering. A single rule can be in multiple groups.RequiredLocalisation key
icon Optional icon.Optional<spriteType>
option Unless other specified, the first option is the default option.Optional, manyblock, containing:
nameRequiredScalar, a "game_rule_options" value
textRequiredLocalisation key
descRequiredLocalisation key
allow_achievements Achievements cannot be earned if one or more game rules are set to an option that has this property set to no. If not specified, this is set to yes for default options and no for all other options.Optionalyes/no
required_dlcOptionalPoland: United and Ready, Together for Victory, Death or Dishonor, Waking the Tiger, Man the Guns, La Resistance, Battle for the Bosporus
default Specify an option with the "default" token to override the behavior of treating the first option as the default.Optionalblock, containing:
nameRequiredScalar, a "game_rule_options" value
textRequiredLocalisation key
descRequiredLocalisation key
allow_achievements Achievements cannot be earned if one or more game rules are set to an option that has this property set to no. If not specified, this is set to yes for default options and no for all other options.Optionalyes/no
required_dlcOptionalPoland: United and Ready, Together for Victory, Death or Dishonor, Waking the Tiger, Man the Guns, La Resistance, Battle for the Bosporus

graphical_terrain

path: common/terrain
fielddescriptionrequiredrhs
typeRequired<terrain>
textureRequiredInteger
spawn_cityOptionalyes
perm_snowOptionalyes
colorRequiredblock, containing:
IntegerRequired

idea

path: common/ideas
fielddescriptionrequiredrhs
<idea_category> of subtype no_slotOptional, manyblock, containing:
ScalarRecommended, manyblock, containing:
nameOptionalLocalisation key
cancel_if_invalidOptionalno
cancel_if_invalidOptionalyes
pictureOptionalScalar
costOptionalInteger
removal_costOptionalInteger
Optional, manytargeted_modifier_rule fields
visibleOptionaltrigger block
allowedOptionaltrigger block
cancelOptionaltrigger block
availableOptionaltrigger block
allowed_civil_warOptionaltrigger block
modifierOptionalmodifier block
ruleOptionalblock, containing:
can_be_called_to_war, can_be_spymaster, can_boost_other_ideologies, can_create_collaboration_government, can_create_factions, can_declare_war_on_same_ideology, can_declare_war_without_wargoal_when_in_war, can_decline_call_to_war, can_force_government, can_generate_female_aces, can_guarantee_other_ideologies, can_join_factions, can_join_factions_not_allowed_diplomacy, can_join_opposite_factions, can_lower_tension, can_not_declare_war, can_occupy_non_war, can_only_justify_war_on_threat_country, can_puppet, can_send_volunteers, can_use_kamikaze_pilots, contributes_operatives, units_deployed_to_overlord, can_boost_own_ideologyRecommended, manyyes/no
research_bonusOptionalblock, containing:
Required, up to 10Float
equipment_bonusOptionalblock, containing:
<equipment>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_planeOptional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
<unit>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
traitsOptionalblock, containing:
<country_leader_trait>Recommended, many
on_addOptionaleffect block
on_removeOptionaleffect block
do_effect While it is used in vanilla and doesn't throw errors, I can't get it to work reliably so I suspect there is some hard-coded strangeness going on here.Optionaltrigger block
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
A "idea_slot" valueOptional, manyblock, containing:
lawOptionalyes/no
use_list_viewOptionalyes/no
designerOptionalyes/no
ScalarRecommended, manyblock, containing:
nameOptionalLocalisation key
levelOptionalInteger
defaultOptionalyes/no
cancel_if_invalidOptionalno
cancel_if_invalidOptionalyes
pictureOptionalScalar
costOptionalInteger
removal_costOptionalInteger
Optional, manytargeted_modifier_rule fields
ledgerOptionalarmy, navy, air, invalid, civilian, hidden, all
visibleOptionaltrigger block
allowedOptionaltrigger block
availableOptionaltrigger block
allowed_civil_warOptionaltrigger block
allowed_to_removeOptionaltrigger block
modifierOptionalmodifier block
ruleOptionalblock, containing:
can_be_called_to_war, can_be_spymaster, can_boost_other_ideologies, can_create_collaboration_government, can_create_factions, can_declare_war_on_same_ideology, can_declare_war_without_wargoal_when_in_war, can_decline_call_to_war, can_force_government, can_generate_female_aces, can_guarantee_other_ideologies, can_join_factions, can_join_factions_not_allowed_diplomacy, can_join_opposite_factions, can_lower_tension, can_not_declare_war, can_occupy_non_war, can_only_justify_war_on_threat_country, can_puppet, can_send_volunteers, can_use_kamikaze_pilots, contributes_operatives, units_deployed_to_overlord, can_boost_own_ideologyRecommended, manyyes/no
equipment_bonusOptionalblock, containing:
<equipment>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_planeOptional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
<unit>Optional, manyblock, containing:
instantOptionalyes/no
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
traitsOptionalblock, containing:
<country_leader_trait>Recommended, many
on_addOptionaleffect block
on_removeOptionaleffect block
do_effect While it is used in vanilla and doesn't throw errors, I can't get it to work reliably so I suspect there is some hard-coded strangeness going on here.Optionaltrigger block
research_bonusOptionalblock, containing:
Recommended, up to 10Float

idea_category

(+) Subtypes

path: common/idea_tags
fielddescriptionrequiredrhs
hidden Whether the ideas are shown anywhere. Default: yesOptionalyes/no
costOptionalInteger
removal_costOptionalInteger
ledgerOptionalarmy, navy, air, invalid, civilian, hidden, all
national_spirit of subtype no_slotOptionalyes/no
slot of subtype slotRequired, manyScalar, a "idea_slot" value

ideology

(+) Subtypes

path: common/ideologies
fielddescriptionrequiredrhs
can_host_government_in_exile of subtype regularOptionalyes
war_impact_on_world_tension of subtype regularRequiredFloat
faction_impact_on_world_tension of subtype regularRequiredFloat
can_be_boosted of subtype regularOptionalyes/no
can_collaborate of subtype regularOptionalyes/no
ai_fascist, ai_communist, ai_democratic, ai_neutral AI playstyle.Optionalyes/no
types of subtype regularRequiredblock, containing:
ScalarRecommended, manyblock, containing:
can_be_randomly_selected of subtype regular won't be assigned to randomly generated country leadersOptionalyes/no
dynamic_faction_names of subtype regularRequiredblock, containing:
Localisation keyOptional, many
ScalarOptional, many
color of subtype regular RGB color of ideology.Requiredblock, containing:
IntegerRequired min 3, up to 3
rules of subtype regularRequiredblock, containing:
can_force_government of subtype regularRequiredyes/no
can_puppet of subtype regularRequiredyes/no
can_send_volunteers of subtype regularRequiredyes/no
can_be_called_to_war, can_be_spymaster, can_boost_other_ideologies, can_create_collaboration_government, can_create_factions, can_declare_war_on_same_ideology, can_declare_war_without_wargoal_when_in_war, can_decline_call_to_war, can_force_government, can_generate_female_aces, can_guarantee_other_ideologies, can_join_factions, can_join_factions_not_allowed_diplomacy, can_join_opposite_factions, can_lower_tension, can_not_declare_war, can_occupy_non_war, can_only_justify_war_on_threat_country, can_puppet, can_send_volunteers, can_use_kamikaze_pilots, contributes_operatives, units_deployed_to_overlord, can_boost_own_ideologyOptional, up to 20yes/no
modifiers of subtype regular Modifiers applied to countries with this ideology.Requiredmodifier block
faction_modifiers of subtype regular Modifiers applied to countries with a faction leader of this ideology.Requiredmodifier block

intelligence_agency

path: common/intelligence_agencies
fielddescriptionrequiredrhs
pictureRequired<spriteType>
namesRequiredblock, containing:
Localisation keyOptional, many
Inline localisation keyOptional, many
defaultRequiredtrigger block
availableRequiredtrigger block

intelligence_agency_upgrade

path: common/intelligence_agency_upgrades
Description Note : There is no "description" field. To add a description, you only need to add an entry "upgrade name" + "_desc" in the localisation files.
fielddescriptionrequiredrhs
pictureRequired<spriteType>
frame GFX entry of the border for the icon, without the suffixe (suffix are _available, _completed and _unavailable ) Optional, "upgrade_frame_1" by default.Optional<spriteType>
sound Optional, "click_default" by default.OptionalScalar
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
modifiers_during_progress Modifiers to apply while the upgrade is being done.Optionalmodifier block
available trigger available, like decisions. Optional. If not available, the upgrade will be visible but locked.Optionaltrigger block
visible trigger visible, like decisions. Optional.Optionaltrigger block
levelRequired, manyblock, containing:
modifier Modifiers for this level of the upgrade.Optionalmodifier block
complete_effect Effects when this level is researched.Optionaleffect block

light

path: gfx/entitiespath: gfx/models
fielddescriptionrequiredrhs
nameRequiredScalar
Optionalintensity fields
radiusRequiredFloat
falloffRequiredFloat
durationOptionalFloat
colorRequiredblock, containing:
rRequiredblock, containing:
FloatRequired
gRequiredblock, containing:
FloatRequired
bRequiredblock, containing:
FloatRequired
positionRequiredblock, containing:
xRequiredInteger
yRequiredInteger
zRequiredInteger
animationOptionalblock, containing:
nameRequiredScalar
startRequiredFloat
durationRequiredFloat
repeatOptionalyes/no
opRequiredMUL, ADD, ABS
minValueOptionalFloat
maxValueOptionalFloat
curveRequiredblock, containing:
FloatRequired min 4, up to 10000

model_animation

path: gfx
fielddescriptionrequiredrhs
nameRequiredScalar
fileRequiredScalar

modifier_definition

path: common/modifier_definitions
fielddescriptionrequiredrhs
color_type the tooltips will be colored accordingly depending if value is positive or notOptionalgood, neutral, bad
value_type type of values in tooltip.Optionalnumber, percentage, percentage_in_hundred, yes_no
precision number of precision for tooltipsOptionalInteger
postfix post fix for values in tooltipOptionalnone, days, hours, daily
category cateogies can be defined if wanted. some tooltips only display certain categories. multiple cateogies can be defined for a single modifier@modifier_tokenOptional, manynone, all, naval, air, unit_leader, country, state, army, peace, politics, ai, defensive, aggressive, war_production, military_advancements, military_equipment, autonomy, government_in_exile, intelligence_agency

module

path: common/units/equipment/modules
fielddescriptionrequiredrhs
categoryRequired
gui_categoryOptional
parentOptional<module>
gfxOptionalScalar
sfxOptionalScalar
add_equipment_typeOptionalinfantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_plane
manpower Manpower required to produce one unit of the equipment (naval only).OptionalInteger
dismantle_cost_icOptionalInteger
add_statsRequiredblock, containing:
Requirednaval_stat fields
Requirednaval_stat fields
build_cost_icOptionalInteger
build_cost_resourcesOptionalblock, containing:
<resource>Optional, up to 10Integer
add_average_statsOptionalblock, containing:
Requirednaval_stat fields
Requirednaval_stat fields
multiply_statsOptional, up to 10block, containing:
Requirednaval_stat fields
Requirednaval_stat fields
can_convert_fromOptional, up to 10block, containing:
module_categoryOptional
moduleOptional<module>
convert_cost_icRequiredInteger
convert_cost_resourcesOptionalblock, containing:
<resource>Recommended, up to 10Integer
critical_partsOptionalblock, containing:
<critical_part>Required
dismantle_cost_resourcesOptionalblock, containing:
<resource>Recommended, up to 10Integer

mtth

path: common/mtth
Description Those mtth entries can be used as variables. Example set_variable = { a = mtth:entry_name }
fielddescriptionrequiredrhs
base, factorRequired64 bit Float or float variable
Requiredmodifier_rule fields

occupation_law

path: common/occupation_laws
fielddescriptionrequiredrhs
tooltip tooltip description for the lawOptionalLocalisation key
icon gfx entry & frame for law entry icon. gfx entry can be omitted, in that case it will default to GFX_occupation_policy_icon_stripOptionalScalar
icon gfx entry & frame for law entry icon. gfx entry can be omitted, in that case it will default to GFX_occupation_policy_icon_stripOptionalInteger
sound_effect plays when the law is selectedOptionalScalar
fallback_law if a current modifier is no longer active (visible/available is false) it will fallback to this lawOptional<occupation_law>
default_lawOptionalyes/no
starting_lawOptionalyes/no
main_fallback_law main fallback modifier will be used when previous modifier is no longer active and there is no fallback_law, there must be exactly one fallback modifier. if you are lacking manpower/equipments for your current laws, fallback modifier bonuses will apply instead (will lerp to fallback and at 0 manpower you will be forced to switch)Optionalyes/no
gui_orderOptionalInteger
visible if a law is not visible, it won't show up in gui at all. scope is occupier country, occupied country is not set (this is only check at country level, not target level)Optionaltrigger block, with scopes ROOT: Country
available if a law is not available, it will show up in disable state ingui and won't be selectable. scope is occupier country and from scope is occupied countryOptionaltrigger block, with scopes ROOT: Country, FROM: Country
state_modifier applies to states if the law is selectedOptionalmodifier block
suppressed_state_modifier states with resistance supressed (at 0) will get this modifier instead (if defined)Optionalmodifier block
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

on_action

(+) Subtypes

path: common/on_actions
fielddescriptionrequiredrhs
random_events of subtype on_new_term_electionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_new_term_electionOptionaleffect block
random_events of subtype on_ace_promotedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ace_promotedOptionaleffect block
random_events of subtype on_aces_killed_each_otherOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_aces_killed_each_otherOptionaleffect block
random_events of subtype on_ace_killed_by_aceOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ace_killed_by_aceOptionaleffect block
random_events of subtype on_ace_killed_other_aceOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ace_killed_other_aceOptionaleffect block
random_events of subtype on_ace_killedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ace_killedOptionaleffect block
random_events of subtype on_justifying_wargoal_pulseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_justifying_wargoal_pulseOptionaleffect block
random_events of subtype on_wargoal_expireOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_wargoal_expireOptionaleffect block
random_events of subtype on_nuke_dropOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_nuke_dropOptionaleffect block
random_events of subtype on_border_war_lostOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_border_war_lostOptionaleffect block
random_events of subtype on_leave_factionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_leave_factionOptionaleffect block
random_events of subtype on_create_factionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_create_factionOptionaleffect block
random_events of subtype on_offer_join_factionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_offer_join_factionOptionaleffect block
random_events of subtype on_join_factionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_join_factionOptionaleffect block
random_events of subtype on_declare_warOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_declare_warOptionaleffect block
random_events of subtype on_faction_formedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_faction_formedOptionaleffect block
random_events of subtype on_capitulationOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_capitulationOptionaleffect block
random_events of subtype on_uncapitulationOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_uncapitulationOptionaleffect block
random_events of subtype on_government_changeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_government_changeOptionaleffect block
random_events of subtype on_naval_invasionOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_naval_invasionOptionaleffect block
random_events of subtype on_coup_succeededOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_coup_succeededOptionaleffect block
random_events of subtype on_civil_war_endOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_civil_war_endOptionaleffect block
random_events of subtype on_puppetOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_puppetOptionaleffect block
random_events of subtype on_release_as_puppetOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_release_as_puppetOptionaleffect block
random_events of subtype on_annexOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_annexOptionaleffect block
random_events of subtype on_subject_freeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_subject_freeOptionaleffect block
random_events of subtype on_subject_autonomy_level_changeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_subject_autonomy_level_changeOptionaleffect block
random_events of subtype on_subject_annexedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_subject_annexedOptionaleffect block
random_events of subtype on_release_as_freeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_release_as_freeOptionaleffect block
random_events of subtype on_peaceconference_endedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_peaceconference_endedOptionaleffect block
random_events of subtype on_generate_wargoalOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_generate_wargoalOptionaleffect block
random_events of subtype on_guaranteeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_guaranteeOptionaleffect block
random_events of subtype on_military_accessOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_military_accessOptionaleffect block
random_events of subtype on_offer_military_accessOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_offer_military_accessOptionaleffect block
random_events of subtype on_call_alliesOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_call_alliesOptionaleffect block
random_events of subtype on_join_alliesOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_join_alliesOptionaleffect block
random_events of subtype on_lend_leaseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_lend_leaseOptionaleffect block
random_events of subtype on_incoming_lend_leaseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_incoming_lend_leaseOptionaleffect block
random_events of subtype on_incoming_lend_leaseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_incoming_lend_leaseOptionaleffect block
random_events of subtype on_send_volunteersOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_send_volunteersOptionaleffect block
random_events of subtype on_send_expeditionary_forceOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_send_expeditionary_forceOptionaleffect block
random_events of subtype on_return_expeditionary_forcesOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_return_expeditionary_forcesOptionaleffect block
random_events of subtype on_request_expeditionary_forcesOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_request_expeditionary_forcesOptionaleffect block
random_events of subtype on_ask_for_state_controlOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ask_for_state_controlOptionaleffect block
random_events of subtype on_give_state_controlOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_give_state_controlOptionaleffect block
random_events of subtype on_war_relation_addedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_war_relation_addedOptionaleffect block
random_events of subtype on_liberateOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_liberateOptionaleffect block
random_events of subtype on_startupOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event>
effect of subtype on_startupOptionaleffect block
random_events of subtype on_dailyOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_dailyOptionaleffect block
random_events of subtype on_weeklyOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_weeklyOptionaleffect block
random_events of subtype on_monthlyOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_monthlyOptionaleffect block
random_events of subtype on_yearlyOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_yearlyOptionaleffect block
random_events of subtype on_thri_yearly_pulseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_thri_yearly_pulseOptionaleffect block
random_events of subtype on_bi_yearly_pulseOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_bi_yearly_pulseOptionaleffect block
random_events of subtype on_state_control_changedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_state_control_changedOptionaleffect block
random_events of subtype on_unit_leader_createdOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_unit_leader_createdOptionaleffect block
random_events of subtype on_unit_leader_level_upOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_unit_leader_level_upOptionaleffect block
random_events of subtype on_army_leader_dailyOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_army_leader_dailyOptionaleffect block
random_events of subtype on_army_leader_won_combatOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_army_leader_won_combatOptionaleffect block
random_events of subtype on_army_leader_lost_combatOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_army_leader_lost_combatOptionaleffect block
random_events of subtype on_army_leader_promotedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype unit_leader_event
effect of subtype on_army_leader_promotedOptionaleffect block
random_events of subtype on_host_changed_from_capitulationOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_host_changed_from_capitulationOptionaleffect block
random_events of subtype on_exile_government_reinstatedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_exile_government_reinstatedOptionaleffect block
random_events of subtype on_civil_war_end_before_annexationOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_civil_war_end_before_annexationOptionaleffect block
random_events of subtype on_government_exiledOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_government_exiledOptionaleffect block
random_events of subtype on_pride_of_the_fleet_sunkOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_pride_of_the_fleet_sunkOptionaleffect block
random_events of subtype on_assume_faction_leadershipOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_assume_faction_leadershipOptionaleffect block
random_events of subtype on_warOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_warOptionaleffect block
random_events of subtype on_peaceOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_peaceOptionaleffect block
random_events of subtype on_peace_proposalOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_peace_proposalOptionaleffect block
random_events of subtype on_operative_on_mission_spottedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_on_mission_spottedOptionaleffect block
random_events of subtype on_operative_capturedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_capturedOptionaleffect block
random_events of subtype on_operative_deathOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_deathOptionaleffect block
random_events of subtype on_operative_detected_during_operationOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_detected_during_operationOptionaleffect block
random_events of subtype on_operative_createdOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_createdOptionaleffect block
random_events of subtype on_operative_recruitedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operative_recruitedOptionaleffect block
random_events of subtype on_operation_completedOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype operative_leader_event
effect of subtype on_operation_completedOptionaleffect block
random_events of subtype on_fully_decrypted_cipherOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_fully_decrypted_cipherOptionaleffect block
random_events of subtype on_activated_active_decryption_bonusesOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_activated_active_decryption_bonusesOptionaleffect block
random_events of subtype on_paradropOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_paradropOptionaleffect block
random_events of subtype on_ruling_party_changeOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_ruling_party_changeOptionaleffect block
random_events of subtype on_stage_coupOptionalblock, containing:
IntegerOptional, many0
IntegerOptional, many<event> of subtype country_event
effect of subtype on_stage_coupOptionaleffect block

oob

path: history/units
fielddescriptionrequiredrhs
start_equipment_factorOptionalFloat
focusOptionalblock, containing:
currentRequired<focus>
progressRequiredFloat above 0
division_templateOptional, manyblock, containing:
nameRequiredScalar
division_names_groupOptional<division_name>
template_counterOptionalInteger
is_lockedOptionalyes/no
template_counterOptionalInteger
priorityOptionalInteger
regimentsRequiredblock, containing:
<unit>Required, up to 25block, containing:
xRequiredInteger between 0 and 5
yRequiredInteger between 0 and 5
supportOptionalblock, containing:
<unit>Recommended, up to 5block, containing:
xRequiredInteger between 0 and 5
yRequiredInteger between 0 and 5
instant_effectOptionaleffect block
unitsOptionalblock, containing:
divisionOptional, manyblock, containing:
nameOptionalScalar
locationRequired
division_templateRequiredScalar
start_experience_factorOptionalFloat between 0 and 1
start_equipment_factorOptionalFloat
division_nameOptionalblock, containing:
is_name_orderedRequiredyes/no
name_orderOptionalInteger
force_equipment_variantsOptional, manyblock, containing:
<equipment> of subtype regular_equipRecommended, manyblock, containing:
ownerRequired
creatorOptional
fleetOptional, manyblock, containing:
nameRequiredScalar
naval_baseRequired
task_forceRecommended, manyblock, containing:
nameRequiredScalar
locationRequired
shipRequired, manyblock, containing:
nameOptionalScalar
ordered_nameOptionalScalar
pride_of_the_fleetOptionalyes
definitionRequired<unit> of subtype ship_unit
start_experience_factorOptionalFloat between 0 and 1
equipmentRequiredblock, containing:
<equipment> of subtype naval_equipRequiredblock, containing:
amountRequiredInteger
ownerRequired
version_nameOptionalScalar
creatorOptional
air_wingsOptionalblock, containing:
start_experience_factor Order is important. start_experience_factor will be assigned to the ace above.Optional, manyFloat between 0 and 1
<equipment> of subtype air_equipOptional, manyblock, containing:
ownerRequired
creatorOptional
amountRequiredInteger
ace Order is important. Ace will be assigned to the wing above.Optional, manyblock, containing:
modifierRequired<ace>
nameRequiredInline localisation key
surnameRequiredInline localisation key
callsignOptionalInline localisation key
portraitOptionalInteger
is_femaleOptionalyes
air_wingsOptionalblock, containing:
<state>Required, manyblock, containing:
start_experience_factor Order is important. start_experience_factor will be assigned to the ace above.Optional, manyFloat between 0 and 1
<equipment> of subtype air_equipRequired, manyblock, containing:
ownerRequired
creatorOptional
amountRequiredInteger
ace Order is important. Ace will be assigned to the wing above.Optional, manyblock, containing:
modifierRequired<ace>
nameRequiredInline localisation key
surnameRequiredInline localisation key
callsignOptionalInline localisation key
portraitOptionalInteger
is_femaleOptionalyes
navy_leaderOptional, manyblock, containing:
nameRequiredScalar
descOptionalLocalisation key
pictureOptionalScalar
portrait_pathOptionalScalar
gfxOptionalScalar
skillRecommendedInteger
attack_skillRecommendedInteger
defense_skillRecommendedInteger
maneuvering_skillRecommendedInteger
coordination_skillRecommendedInteger
idOptionalScalar, a "unit_leader_ids" value
femaleOptionalyes/no
flagsOptionalblock, containing:
Scalar, a "leader_flag" valueRecommended, manyblock, containing:
valueRequired1
traits Sets starting traits for this leader. If empty, sets no traits. If missing, assigns a random trait.Requiredblock, containing:
<unit_leader_trait>Optional, many
field_marshalOptional, manyblock, containing:
nameRequiredScalar
descOptionalLocalisation key
pictureOptionalScalar
portrait_pathOptionalScalar
gfxOptionalScalar
skillRecommendedInteger
attack_skillRecommendedInteger
defense_skillRecommendedInteger
planning_skillRecommendedInteger
logistics_skillRecommendedInteger
idOptionalScalar, a "unit_leader_ids" value
femaleOptionalyes/no
flagsOptionalblock, containing:
Scalar, a "leader_flag" valueRecommended, manyblock, containing:
valueRequired1
traits Sets starting traits for this leader. If empty, sets no traits. If missing, assigns a random trait.Requiredblock, containing:
<unit_leader_trait>Optional, many
corps_commanderOptional, manyblock, containing:
nameOptionalScalar
descOptionalLocalisation key
pictureOptionalScalar
portrait_pathOptionalScalar
gfxOptionalScalar
skillRecommendedInteger
attack_skillRecommendedInteger
defense_skillRecommendedInteger
planning_skillRecommendedInteger
logistics_skillRecommendedInteger
idOptionalScalar, a "unit_leader_ids" value
femaleOptionalyes/no
flagsOptionalblock, containing:
Scalar, a "leader_flag" valueRecommended, manyblock, containing:
valueRequired1
traits Sets starting traits for this leader. If empty, sets no traits. If missing, assigns a random trait.Requiredblock, containing:
<unit_leader_trait>Optional, many

operation

path: common/operations
fielddescriptionrequiredrhs
iconRequired<spriteType>
map_iconRequired<spriteType>
nameRequiredLocalisation key
descRequiredLocalisation key
priority Priority determines in which order they are listed from the list of operations in the Intelligence Agency window. The higher the number the earlier in the list it will beOptionalInteger
days Every operation needs a duration in days that it takes to execute itRequiredInteger
danger_level The danger level the target country will perceived once this operation is initiated (default = 0)OptionalInteger
operatives The number of operatives requires to be assigned to an operation for it to startRequiredInteger
network_strength Every operation has a hard requirement of network strength in the target country Integer [0-100]RequiredInteger between 0 and 100
prevent_captured_operative_to_die Used for rescue operative operationsOptionalyes/no
cost_multiplier Multiplier for the operation costOptionalFloat
experience Experience awarded by the operationOptionalFloat
scale_cost_independent_of_target Sets a fixed scaling instead of per target sizeOptionalyes/no
risk_chanceOptionalFloat between 0 and 1
target_type Determines the selector type. Currently supported are: [ province, strategic_region ]Optionalprovince
target_typeOptionalstrategic_region
return_on_complete Default: no - will refund all equipment cost for this operation at the end of the operation [ operation phases costs have their own specifier in the operation database ]Optionalyes
outcome_extra_chance Chance for outcome_execute_extra to happen (assuming it exists), otherwise outcome_extra will be executedOptionalFloat between 0 and 1
will_lead_to_war_with Used to warn the AI about an upcoming war with the target of the operationOptionalyes/no
phases This is where all the separate phases are defined, There can be any number of phases, they will be evenly split over the total duration of the operationRequired, manyblock, containing:
<operation_phase> Each phase for an operation may have a single actual phase assigned to it, which is determined here, Every <phase id> can have a base chance as well as any number of modifiersRequired, manyblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
ai_will_do Behaves like any other ai_will_do, IF the total weight factor falls below OPERATION_AI_MINIMUM_SCORE, THEN the AI will cancel the operation if it was currently planning itOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
allowed Determines whether the operation is visible to the player, Default = { always = yes }Optionaltrigger block, with scopes ROOT: Country
available Determines whether the operation can be launched by the player, Default = { always = yes }Optionaltrigger block, with scopes ROOT: Country, FROM: Country
visible Determines whether the operation will be visible to the player, If no trigger used it will fall back to a default where it shows operations with network strength below NOperatives::INTEL_NETWORK_MIN_DEFAULT_FOR_SHOWING or when reaching half its network requirements. It will also only show operations with one level higher operation count than you currently have.Optionaltrigger block, with scopes ROOT: Country, FROM: Country
risk_modifiers List of modifiers that apply to risk_chanceOptionalblock, containing:
Optional, many
Optional, many
awarded_tokens Determines the potentially awarded token(s) - this is for display purposes only in tooltipsOptionalblock, containing:
<operation_token>Required, many
cost_modifiers List of traits that affect the cost of an operationOptionalblock, containing:
Optional, many
Optional, many
operation_target If no operation_target is defined it will be allowed for all countriesOptionalblock, containing:
targetsRequiredblock, containing:
Scope object in [Country] scopeRequired, many
selection_target Determines the valid countries for province selection. If set this will enable the UI to select a target provinceOptionalblock, containing:
targetsRequiredblock, containing:
Scope object in [Country] scopeRequired, many
selection_target_state Determines the valid states for province selectionOptionaltrigger block, with scopes ROOT: State
equipment Equipment base cost for the operation, Note: Exceptionally supports `civilian_factories` as an equipment type. It works like the agency creation cost, where it allocates a number of factories over timeOptionalblock, containing:
<equipment>Optional, manyInteger
civilian_factoriesOptional, manyInteger
civilian_factoriesOptional, manyblock, containing:
amountRequiredInteger
daysRequiredInteger
required_tokens Determines required token(s) - against target country - to launch the operationOptionalblock, containing:
<operation_token>Recommended, many
target_weightOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
requirements Determines requirements other than equipment to launch the operationOptionaltrigger block, with scopes ROOT: Country, FROM: Country
on_start Executed when an operation startsOptionaleffect block, with scopes ROOT: Country, FROM: Country
outcome_potential For description purposes only. This is the effect that generates that text shown as a potential reward for completing the operationOptionaleffect block
outcome_modifiers List of modifiers that apply to outcome_chanceOptionalblock, containing:
Optional, many
Optional, many
outcome_execute Executed when the operation has completed [ once per operation ]Optionaleffect block
outcome_extra_execute Same as outcome_executeOptionaleffect block

operation_phase

path: common/operation_phases
fielddescriptionrequiredrhs
name Every phase needs a name to be displayedRequiredLocalisation key
desc Every phase needs a description to show what it is aboutRequiredLocalisation key
icon Every phase needs an icon for display purposesRequired<spriteType>
pictureRequired<spriteType>
outcome Outcome text that is used to build the final outcome stringOptionalLocalisation key
map_icon map icon, will use regular icon if none specifiedOptional<spriteType>
outcome_extra Outcome text that is used to build the final outcome string - This happens if a risk_extra has happened ( something bad ) to at least one of the operatives. We usually only specify outcome_extra for exfiltration phases, technically all phases use outcome_extra, but if none is defined for it ( as in our use case it would not make sense ) then it will default fallback to outcome. Some modders might have a different use case for this, so support is there and it uses outocme_extra for all phases of an operation that had something risky happen. Can be used to build a different storyline from an operation where everthing went smooth.OptionalLocalisation key
risk_extraOptionalLocalisation key
return_on_complete Default: no - will refund all equipment cost for this operation phase at the end of the operation [ operation costs have their own specifier in the operation database ]Optionalyes/no
requirements requirements is a trigger that will be visible in the UI and determines the set of requirements necessary to start an operation. They are used for phase selection. If this trigger is not successful ( checked on a weekly basis ) then the phase is invalid. PreSeeded operations will be ReSeeded with new phases if one of theirs becomes invalidOptionaltrigger block, with scopes ROOT: Country, FROM: Country
equipment Equipment cost that is scalable by the multiplier defined in the operation. Note: Exceptionally supports `civilian_factories` as an equipment type. It works like the agency creation cost, where it allocates a number of factories over timeOptionalblock, containing:
<equipment>Optional, manyInteger
civilian_factoriesOptional, manyInteger
civilian_factoriesOptional, manyblock, containing:
amountRequiredInteger
daysRequiredInteger

operation_token

path: common/operation_tokens
fielddescriptionrequiredrhs
name Every token needs a name to be displayedRequiredLocalisation key
desc Every token needs a description to show what it is aboutRequiredLocalisation key
icon Every token needs an icon for display purposesRequired<spriteType>
text_iconRequired<spriteType>
targeted_modifier Every token can have any number of targeted modifier listed as demonstrated below. Those will be applied to the relation between the origin country and the target country of the operation. For as long as the origin country that receives the token posses the token, when the token is consumed the modifiers will go awayOptional, many<dynamic_modifier>
intel_source Intel Source Gains. A token may grant intel gains against of one value for one source per token. Multiple intel gains per token are NOT supported. Supported sources are: navy, army, civilian, airforceOptionalnavy, army, civilian, airforce
intel_gain Intel Source Gains. A token may grant intel gains against of one value for one source per token. Multiple intel gains per token are NOT supported. Supported sources are: navy, army, civilian, airforceOptionalFloat

opinion

path: common/opinion_modifiers
fielddescriptionrequiredrhs
valueRequiredInteger
tradeOptionalyes/no
decayOptionalFloat
min_trustOptionalInteger
max_trustOptionalInteger
targetOptionalyes/no
days, months, yearsOptionalInteger

particle

path: gfx/particlespath: gfx/particles/environmentpath: gfx/particles/infantrypath: gfx/particles/vehiclespath: gfx/entitiespath: gfx/models
fielddescriptionrequiredrhs
nameRequiredScalar
subsystemRequired, manyblock, containing:
nameOptionalScalar
max_amountOptionalInteger
slave_particlesOptionalInteger
emitter_typeOptionalpoint, sphere, box
invertOptionalyes/no
trailOptionalyes/no
local_spaceOptionalyes/no
billboardOptionalyes/no
hideOptionalyes/no
Requiredsubsystem_color fields
durationRequiredFloat
lifeRequiredFloat
Requiredemission fields
sizeRequiredFloat
sizeRequiredScalar
rotationOptionalFloat
rotationOptionalScalar
sortOptionaldepth, age
rotation_speedOptionalFloat
rotation_speed_yawOptionalFloat
rotation_speed_pitchOptionalFloat
sphere_emitter_radiusOptionalFloat
sphere_emitter_yawOptionalFloat
sphere_emitter_pitchOptionalFloat
startOptionalFloat
Requiredemission fields
box_emitter_xOptionalFloat
box_emitter_xOptionalScalar
box_emitter_yOptionalScalar
box_emitter_zOptionalScalar
velocityOptionalFloat
velocity_pitchOptionalScalar
velocity_yawOptionalFloat
emitter_pitchOptionalFloat
emitter_yawOptionalFloat
emission_pulse_durationOptionalFloat
emission_pulse_silenceOptionalFloat
particle_pitchOptionalFloat
particle_yawOptionalScalar
forceOptionalScalar
textureOptionalblock, containing:
fileRequiredFilepath
shaderRequiredScalar
xOptionalInteger
yOptionalInteger
positionOptionalblock, containing:
xOptionalFloat
yOptionalFloat
zOptionalFloat
lifeRequiredblock, containing:
FloatRequired, up to 2
sizeRequiredblock, containing:
ScalarRequired, up to 2
rotationOptionalblock, containing:
ScalarRequired, up to 2
rotation_speed_rollOptionalblock, containing:
FloatRequired min 2, up to 2
rotation_speedOptionalblock, containing:
FloatRequired min 2, up to 2
sphere_emitter_radiusOptionalblock, containing:
ScalarRequired min 2, up to 2
sphere_emitter_yawOptionalblock, containing:
FloatRequired min 2, up to 2
sphere_emitter_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
startOptionalblock, containing:
FloatRequired, up to 2
box_emitter_xOptionalblock, containing:
FloatRequired min 2, up to 2
box_emitter_yOptionalblock, containing:
FloatRequired min 2, up to 2
box_emitter_zOptionalblock, containing:
FloatRequired min 2, up to 2
velocityOptionalblock, containing:
FloatRequired, up to 2
velocity_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
velocity_yawOptionalblock, containing:
FloatRequired min 2, up to 2
emitter_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
emitter_yawOptionalblock, containing:
FloatRequired min 2, up to 2
particle_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
particle_yawOptionalblock, containing:
ScalarRequired min 2, up to 2
particle_rollOptionalblock, containing:
FloatRequired min 2, up to 2
childsystemOptionalblock, containing:
nameOptionalScalar
max_amountOptionalInteger
slave_particlesOptionalInteger
emitter_typeOptionalpoint, sphere, box
invertOptionalyes/no
trailOptionalyes/no
local_spaceOptionalyes/no
billboardOptionalyes/no
hideOptionalyes/no
Requiredsubsystem_color fields
durationRequiredFloat
lifeRequiredFloat
Requiredemission fields
sizeRequiredFloat
rotationOptionalFloat
sortOptionaldepth, age
rotation_speedOptionalFloat
rotation_speed_pitchOptionalFloat
sphere_emitter_radiusOptionalFloat
sphere_emitter_yawOptionalFloat
startOptionalFloat
box_emitter_xOptionalFloat
box_emitter_xOptionalScalar
box_emitter_yOptionalScalar
box_emitter_zOptionalScalar
velocityOptionalFloat
velocity_pitchOptionalScalar
velocity_yawOptionalFloat
emitter_pitchOptionalFloat
emitter_yawOptionalFloat
emission_pulse_durationOptionalFloat
emission_pulse_silenceOptionalFloat
particle_pitchOptionalFloat
particle_yawOptionalFloat
forceOptionalScalar
textureOptionalblock, containing:
fileRequiredFilepath
shaderRequiredScalar
xOptionalInteger
yOptionalInteger
positionOptionalblock, containing:
xOptionalFloat
yOptionalFloat
zOptionalFloat
lifeRequiredblock, containing:
FloatRequired, up to 2
sizeRequiredblock, containing:
ScalarRequired, up to 2
rotationOptionalblock, containing:
ScalarRequired, up to 2
rotation_speed_rollOptionalblock, containing:
FloatRequired min 2, up to 2
rotation_speedOptionalblock, containing:
FloatRequired min 2, up to 2
sphere_emitter_radiusOptionalblock, containing:
ScalarRequired min 2, up to 2
sphere_emitter_yawOptionalblock, containing:
FloatRequired min 2, up to 2
sphere_emitter_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
startOptionalblock, containing:
FloatRequired min 2, up to 2
box_emitter_xOptionalblock, containing:
FloatRequired min 2, up to 2
box_emitter_yOptionalblock, containing:
FloatRequired min 2, up to 2
box_emitter_zOptionalblock, containing:
FloatRequired min 2, up to 2
velocityOptionalblock, containing:
FloatOptional, up to 2
velocity_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
velocity_yawOptionalblock, containing:
FloatRequired min 2, up to 2
emitter_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
emitter_yawOptionalblock, containing:
FloatRequired min 2, up to 2
particle_pitchOptionalblock, containing:
FloatRequired min 2, up to 2
particle_yawOptionalblock, containing:
FloatRequired min 2, up to 2
particle_rollOptionalblock, containing:
FloatRequired min 2, up to 2
animationOptional, manyblock, containing:
nameRequiredScalar
startRequiredFloat
durationRequiredFloat
repeatOptionalyes/no
minValueRequiredFloat
maxValueRequiredFloat
opRequiredMUL, ADD, ABS
timeRequiredlife, life_abs, system, spawn
curveRequiredblock, containing:
FloatRequired min 4, up to 10000
forceOptional, manyblock, containing:
nameRequiredScalar
typeRequiredfriction, planar, point, spin, turbulence, vortex
local_forceOptionalyes/no
yawOptionalFloat
divisionOptionalInteger
amountOptionalFloat
amountOptionalScalar
positionOptionalblock, containing:
FloatRequired min 3, up to 3
directionOptionalblock, containing:
FloatRequired min 3, up to 3
amountOptionalblock, containing:
FloatRequired

pdxmesh

path: gfx
fielddescriptionrequiredrhs
nameRequiredScalar
fileRequiredFilepath
scaleOptionalFloat
cull_distanceOptionalFloat
animationOptional, manyblock, containing:
idRequiredScalar
typeRequired<model_animation>
meshsettingsOptional, manyblock, containing:
nameOptionalScalar
indexOptionalInteger
texture_diffuseOptionalScalar
texture_normalOptionalScalar
texture_specularOptionalScalar
shaderOptionalScalar

pdxparticle

path: gfx/particlespath: gfx/entitiespath: gfx/models
fielddescriptionrequiredrhs
nameRequiredScalar
typeRequired<particle>
scaleOptionalFloat

resistance_compliance_modifier

(+) Subtypes

path: common/resistance_compliance_modifiers
fielddescriptionrequiredrhs
typeRequiredstate_resistance_modifier, state_compliance_modifier, core_resistance_modifier, core_compliance_modifier
icon GFX entry & frame for law entry icon. both frame and gfx name can be ommited, in that case it will default to GFX_occupation_modifier_stripRequiredScalar
small_icon Small icon will be used for progress bars (GFX_occupation_modifier_small_strip is default gfx)RequiredScalar
threshold Percentage threshold to enable.RequiredInteger
margin Margin to disable the modifier back. It will be disabled if current value < threshold - margin.RequiredInteger
alert_levelOptionalhigh, medium, low
alert_marginOptionalInteger
state_modifier Will be added to state if modifier is enabled.Optionalmodifier block
visible of subtype core If visible is false, the modifier will not show up anywhere.Optionaltrigger block, with scopes ROOT: Country, FROM: Country
enabled of subtype core If enabled is false, the modifier won't be enabled even if it passes threshold (and will be disabled if it was enabled before).Optionaltrigger block, with scopes ROOT: Country, FROM: Country
on_enable of subtype core The effect will be called when modifier is enabled.Optionaleffect block, with scopes ROOT: Country, FROM: Country
on_disable of subtype core The effect will be called when modifier is disabled.Optionaleffect block, with scopes ROOT: Country, FROM: Country
visible of subtype state If visible is false, the modifier will not show up anywhere.Optionaltrigger block, with scopes ROOT: Country, FROM: Country, FROMFROM: Country
enabled of subtype state If enabled is false, the modifier won't be enabled even if it passes threshold (and will be disabled if it was enabled before).Optionaltrigger block, with scopes ROOT: Country, FROM: Country, FROMFROM: Country
on_enable of subtype state The effect will be called when modifier is enabled.Optionaleffect block, with scopes ROOT: Country, FROM: Country, FROMFROM: Country
on_disable of subtype state The effect will be called when modifier is disabled.Optionaleffect block, with scopes ROOT: Country, FROM: Country, FROMFROM: Country

resource

path: common/resources
fielddescriptionrequiredrhs
icon_frame Icon frame from file.RequiredInteger
cic 1 unit of resource costs this many civ factories.RequiredFloat
convoys This many convoys to convey one unit of resource.RequiredFloat

rocketsites

path: map
fielddescriptionrequiredrhs
<state>Required, manyblock, containing:
Required

scripted_effect

path: common/scripted_effects
fielddescriptionrequiredrhs
Requiredeffect fields

scripted_gui

(+) Subtypes

path: common/scripted_guis
fielddescriptionrequiredrhs
window_name Name of corresponding GUI container.Required<containerWindowType>
context_typeOptionalglobal_context, player_context, decision_category, selected_state_context, selected_country_context
parent_window_tokenOptionaltop_bar, decision_tab, technology_tab, trade_tab, construction_tab, production_tab, deployment_tab, logistics_tab, diplomacy_tab, politics_tab, tech_infantry_folder, tech_support_folder, tech_armor_folder, tech_artillery_folder, tech_land_doctrine_folder, tech_naval_folder, tech_naval_doctrine_folder, tech_air_techs_folder, tech_air_doctrine_folder, tech_electronics_folder, tech_industry_folder, national_focus, selected_state_view, selected_country_view, selected_country_view_info, selected_country_view_diplomacy
parent_window_name Any GUI container name. Use only if parent_window_token doesn't have a corresponding token.Optional<containerWindowType>
parent_window_name Any GUI container name. Use only if parent_window_token doesn't have a corresponding token.Optional
dirty By default the scripted guis will update the gui with every gameplay change (every hourly tick. every time you click something that affects game etc). For large scripted guis this can become quite heavy. If you scripted gui is not updated regularly and you know when it will needs an update, you can use the dirty variable feature. dirty = var_name Once this is defined, the game will check if the value of variable named "var_name" is updated or not. It will only update the scripted gui if that value is changed. It will read the variable from the scope of the scripted gui (player scope or targeted scope etc). When you call an effect that will change the contents of a scripted gui, you can also call `add_to_variable = { var_name = 1 }` to change that dirty variable to retrigger and update on the interfaceOptionalScalar, a "variable" value
ai_test_interval Number of hours between each AI check. Default: 24OptionalInteger
ai_test_variance Variance of number of hours between each AI check. Default: 0.2OptionalFloat
ai_max_weight_taken_per_test By default, AI can click at most 1 button per instance of interval. On each check, it will create a list of things that it can click and it will click the one with highest score. If you want AI to be able to click multiple stuff on same tick you can use this.OptionalInteger
ai_test_parent By default, every scripted GUI has its own AI. It will do prioritization process separately for each GUI. If you want AI to check different scripted GUIs at same interval and compare ai_will_do with each other as well, you can make on of them parent of each other. If you add this entry to a scripted GUI, this scripted GUI will be tested along with 'fuhrer_mana_powers' and it will share its effects with the other one while prioritizing stuff. For example both fuhrer_enemy_country_spells and fuhrer_self_state_spells defines fuhrer_spells as parent and AI evaluates them at the same time. This is done because AI for fuhrer_enemy_country_spells has an AI entry for meteor swarm that blocks everything else to save mana if there is a legit enemy. If you define a parent, you shouldn't define ai_test_interval, ai_test_variance and ai_max_weight_taken_per_test in child AIs since it will share parent's.Optional<scripted_gui>
propertiesOptionalblock, containing:
ScalarRecommended, manyblock, containing:
image Should return name of the texture in gfx file.OptionalInline localisation key
frameOptional64 bit Float or float variable
xOptional64 bit Float or float variable
yOptional64 bit Float or float variable
dynamic_listsOptionalblock, containing:
ScalarRecommended, manyblock, containing:
array The array that will be used for populating the grid.Required64 bit Float or float variable
change_scope Since our array contains scope objects (countries) we can set change_scope to yes, which will chance current scope to array element while displaying the lists.Optionalyes/no
entry_container GUI container name of the entry.RequiredScalar
index current index and value is also stored as temp variables and can be used in effects/triggers if wanted. You can rename them to another temp variablesOptionalScalar
value current index and value is also stored as temp variables and can be used in effects/triggers if wanted. You can rename them to another temp variablesOptionalScalar
ai_weights Ai_weights of lists are stored under its list entry.Optionalblock, containing:
ScalarRecommended, manyblock, containing:
ai_will_doRequiredblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ai_test_scopes of subtype any_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_country, test_enemy_countries, test_ally_countries, test_neighbouring_countries, test_neighbouring_ally_countries, test_neighbouring_enemy_countries, test_if_only_major
ai_test_scopes of subtype any_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_owned_states, test_enemy_owned_states, test_ally_owned_states, test_self_controlled_states, test_enemy_controlled_states, test_ally_controlled_states, test_neighbouring_states, test_neighbouring_enemy_states, test_neighbouring_ally_states, test_our_neighbouring_states, test_our_neighbouring_states_against_allies, test_our_neighbouring_states_against_enemies, test_contesded_states, test_if_only_coastal
effects of subtype any_contextOptionalblock, containing:
ScalarRecommended, manyeffect block, with scopes ROOT: Country, FROM: Any
visible of subtype any_contextOptionaltrigger block, with scopes ROOT: Country, FROM: Any
triggers of subtype any_contextOptionalblock, containing:
ScalarRecommended, manytrigger block, with scopes ROOT: Country, FROM: Any
ai_check_scope of subtype any_context AI makes a final check on each target scope:ai_check_scope. If this trigger is false, AI will ignore that scope.Optionaltrigger block
ai_test_scopes of subtype global_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_country, test_enemy_countries, test_ally_countries, test_neighbouring_countries, test_neighbouring_ally_countries, test_neighbouring_enemy_countries, test_if_only_major
ai_test_scopes of subtype global_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_owned_states, test_enemy_owned_states, test_ally_owned_states, test_self_controlled_states, test_enemy_controlled_states, test_ally_controlled_states, test_neighbouring_states, test_neighbouring_enemy_states, test_neighbouring_ally_states, test_our_neighbouring_states, test_our_neighbouring_states_against_allies, test_our_neighbouring_states_against_enemies, test_contesded_states, test_if_only_coastal
effects of subtype global_contextOptionalblock, containing:
ScalarRecommended, manyeffect block, with scopes ROOT: Country
visible of subtype global_contextOptionaltrigger block, with scopes ROOT: Country
triggers of subtype global_contextOptionalblock, containing:
ScalarRecommended, manytrigger block, with scopes ROOT: Country
ai_check_scope of subtype global_context AI makes a final check on each target scope:ai_check_scope. If this trigger is false, AI will ignore that scope.Optionaltrigger block, with scopes ROOT: Country
visible of subtype player_contextOptionaltrigger block, with scopes ROOT: Country
effects of subtype player_contextOptionalblock, containing:
ScalarRecommended, manyeffect block, with scopes ROOT: Country
triggers of subtype player_contextOptionalblock, containing:
ScalarRecommended, manytrigger block, with scopes ROOT: Country
ai_test_scopes of subtype country_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_country, test_enemy_countries, test_ally_countries, test_neighbouring_countries, test_neighbouring_ally_countries, test_neighbouring_enemy_countries, test_if_only_major
visible of subtype country_contextOptionaltrigger block, with scopes ROOT: Country
effects of subtype country_contextOptionalblock, containing:
ScalarRecommended, manyeffect block, with scopes ROOT: Country
triggers of subtype country_contextOptionalblock, containing:
ScalarRecommended, manytrigger block, with scopes ROOT: Country
ai_check_scope of subtype country_context AI makes a final check on each target scope:ai_check_scope. If this trigger is false, AI will ignore that scope.Optionaltrigger block, with scopes ROOT: Country
ai_test_scopes of subtype state_context Limits AI to selected scopes. When used multiple times, will use all matching scopes.Optional, manytest_self_owned_states, test_enemy_owned_states, test_ally_owned_states, test_self_controlled_states, test_enemy_controlled_states, test_ally_controlled_states, test_neighbouring_states, test_neighbouring_enemy_states, test_neighbouring_ally_states, test_our_neighbouring_states, test_our_neighbouring_states_against_allies, test_our_neighbouring_states_against_enemies, test_contesded_states, test_if_only_coastal
visible of subtype state_contextOptionaltrigger block, with scopes ROOT: Country
effects of subtype state_contextOptionalblock, containing:
ScalarRecommended, manyeffect block, with scopes ROOT: Country
triggers of subtype state_contextOptionalblock, containing:
ScalarRecommended, manytrigger block, with scopes ROOT: Country
ai_check_scope of subtype state_context AI makes a final check on each target scope:ai_check_scope. If this trigger is false, AI will ignore that scope.Optionaltrigger block, with scopes ROOT: Country
ai_enabled Ai_enabled entry is the best optimization you can set. While initialization AI, it will check every scripted GUI for every country and will test ai_enabled with its country scope. If ai_enabled is false, AI will ignore that scripted GUI forever.Optionaltrigger block, with scopes ROOT: Country
ai_check Called on every tick of the interval you specified and the scope is again country scope. If this is false, AI will ignore your GUI in that tick.Optionaltrigger block, with scopes ROOT: Country
ai_weightsOptionalblock, containing:
weightOptionalInteger
ScalarRecommended, manyblock, containing:
ai_will_do of subtype player_contextRequiredblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ignore_lower_weights of subtype player_contextOptionalblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ai_will_do of subtype country_contextRequiredblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ignore_lower_weights of subtype country_contextOptionalblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ai_will_do of subtype state_contextRequiredblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields
ignore_lower_weights of subtype state_contextOptionalblock, containing:
base, factorOptional64 bit Float or float variable
Requiredmodifier_rule fields

scripted_loc

path: common/scripted_loc
fielddescriptionrequiredrhs
nameRequiredScalar
textOptional, manyblock, containing:
localization_keyOptionalInline localisation key
triggerOptionaltrigger block
random_listOptionalblock, containing:
IntegerRequired, manyblock, containing:
Requiredmodifier_rule fields
localization_keyRequiredInline localisation key

scripted_trigger

path: common/scripted_triggers
fielddescriptionrequiredrhs
Requiredtrigger fields

shared_focus

path: common/national_focus
fielddescriptionrequiredrhs
idRequiredLocalisation key
textOptionalLocalisation key
iconRecommended<spriteType>
costRequiredFloat
xRequiredInteger
yRequiredInteger
relative_position_idOptional<shared_focus>
relative_position_idOptional<focus>
dynamic Used for focuses that can change title/desc.Optionalyes
dynamicOptionalno
available_if_capitulatedOptionalyes
available_if_capitulatedOptionalno
cancel_if_invalidOptionalyes
cancel_if_invalidOptionalno
continue_if_invalidOptionalyes
continue_if_invalidOptionalno
cancelableOptionalno
cancelableOptionalyes
bypass_if_unavailableOptionalyes
bypass_if_unavailableOptionalno
will_lead_to_war_withOptional, manyScope object in [Country] scope
will_lead_to_war_withOptional, many
offsetOptional, manyblock, containing:
xOptionalInteger
yOptionalInteger
triggerOptionaltrigger block
prerequisiteOptional, manyblock, containing:
focusOptional, many<shared_focus>
focusOptional, many<focus>
mutually_exclusiveOptional, manyblock, containing:
focusOptional, many<shared_focus>
focusOptional, many<focus>
bypassOptionaltrigger block
allow_branchOptionaltrigger block
availableOptionaltrigger block
cancelOptionaltrigger block
historical_aiOptionaltrigger block
select_effectOptionaleffect block
complete_tooltipOptionaleffect block
completion_rewardRecommendedeffect block
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
search_filtersOptionalblock, containing:
Scalar, a "focus_filter" valueRecommended, many

ship_name

path: common/units/names_ships
fielddescriptionrequiredrhs
nameRequiredLocalisation key
typeRequiredship
prefixOptionalScalar
fallback_nameOptionalScalar
for_countriesOptionalblock, containing:
Recommended, many
can_useOptionaltrigger block
ship_typesOptionalblock, containing:
<equipment> of subtype naval_equipRecommended, many
<unit> of subtype ship_unitRecommended, many
battle_cruiser, battleship, capital_ship, carrier, convoy, destroyer, heavy_cruiser, light_cruiser, screen_ship, submarineRecommended, many
uniqueOptionalblock, containing:
ScalarRecommended, many
unorderedOptionalblock, containing:
IntegerRecommended, manyblock, containing:
ScalarRequired
orderedOptionalblock, containing:
IntegerRecommended, manyblock, containing:
ScalarRequired

spriteType

(+) Subtypes

path: interface
fielddescriptionrequiredrhs
nameRequiredScalar
effectFileOptionalScalar
noOfFramesOptionalInteger
animation_rate_fpsOptionalFloat
loopingOptionalyes/no
play_on_showOptionalyes/no
loadTypeOptionalScalar
transparencecheckOptionalyes/no
legacy_lazy_loadOptionalyes/no
pause_on_loopOptionalFloat
alwaystransparentOptionalyes/no
animationOptional, manyblock, containing:
animationmaskfileOptionalScalar
animationtexturefileOptionalScalar
animationrotationOptionalFloat
animationloopingOptionalyes/no
animationtimeOptionalFloat
animationdelayOptionalFloat
animationtypeOptionalScalar
animationblendmodeOptionalScalar
animationrotationoffsetOptionalblock, containing:
xRequiredFloat
yRequiredFloat
animationtexturescaleOptionalblock, containing:
xRequiredFloat
yRequiredFloat
animationframesOptionalblock, containing:
IntegerRequired, many
textureFile of subtype spriteTypeRequiredFilepath
textureFile of subtype frameAnimatedSpriteTypeRequiredFilepath
textureFile of subtype corneredTileSpriteTypeRequiredFilepath
tilingCenter of subtype corneredTileSpriteTypeOptionalyes/no
borderSize of subtype corneredTileSpriteTypeRequiredblock, containing:
x of subtype corneredTileSpriteTypeRequiredInteger
y of subtype corneredTileSpriteTypeRequiredInteger
size of subtype corneredTileSpriteTypeRequiredblock, containing:
x of subtype corneredTileSpriteTypeRequiredInteger
y of subtype corneredTileSpriteTypeRequiredInteger
textureFile1 of subtype maskedShieldTypeRequiredScalar
textureFile2 of subtype maskedShieldTypeRequiredScalar
textureFile1 of subtype progressbartypeRequiredScalar
textureFile2 of subtype progressbartypeRequiredScalar
horizontal of subtype progressbartypeRequiredyes/no
steps of subtype progressbartypeRequiredInteger
size of subtype progressbartypeRequiredblock, containing:
x of subtype progressbartypeRequiredInteger
y of subtype progressbartypeRequiredInteger
color of subtype progressbartypeRequiredblock, containing:
FloatRequired min 3, up to 3
colortwo of subtype progressbartypeRequiredblock, containing:
FloatRequired min 3, up to 3

state

path: history/states
fielddescriptionrequiredrhs
idRequiredInteger
nameRequiredLocalisation key
manpowerRequiredInteger above 0
buildings_max_level_factorOptionalFloat
state_categoryRequired<state_category>
impassableOptionalyes
resourcesOptionalblock, containing:
<resource>Recommended, manyFloat
historyRequiredblock, containing:
ownerRequired
controllerOptional
Requiredeffect fields
victory_pointsOptional, manyblock, containing:
Required min 2, up to 2
buildingsOptionalblock, containing:
<building>Optional, manyInteger between 0 and 20
Optional, manyblock, containing:
<building>Optional, manyInteger between 0 and 20
Date with YYYY.MM.dd format, starting from 1.1.1Optional, manyblock, containing:
ownerOptional
controllerOptional
Requiredeffect fields
victory_pointsOptional, manyblock, containing:
Required min 2, up to 2
buildingsOptionalblock, containing:
<building>Optional, manyInteger between 0 and 20
Optional, manyblock, containing:
<building>Optional, manyInteger between 0 and 20
provincesRequiredblock, containing:
Recommended, many

state_category

path: common/state_category
fielddescriptionrequiredrhs
local_building_slotsRequiredInteger
colorRequiredblock, containing:
IntegerRequired min 3, up to 3

static_modifier

(+) Subtypes

path: common/modifiers
fielddescriptionrequiredrhs
Requiredmodifier fields
Requiredunit_stat fields
Requiredair_stat fields
Requirednaval_stat fields
valid_relation_trigger of subtype relation_modifierRequiredtrigger block

strategic_region

path: map/strategicregions
fielddescriptionrequiredrhs
idRequiredInteger
nameRequiredLocalisation key
naval_terrainOptional<terrain> of subtype naval_terrain
provincesRequiredblock, containing:
Recommended, many
static_modifiersOptionalblock, containing:
<static_modifier>Required, manyalways
weather Black magic.Requiredblock, containing:
period Periods of weather, months in vanilla.Optional, manyblock, containing:
no_phenomenon, rain_light, rain_heavy, snow, blizzard, arctic_water, mud, sandstormRequired min 7, up to 8Float above 0
min_snow_levelRequiredFloat
betweenRequiredblock, containing:
Float between 0.0 and 30.9 Day.month (both start at 0)Required min 2, up to 2
temperatureRequiredblock, containing:
FloatRequired min 2, up to 2
temperature_day_nightRequiredblock, containing:
FloatRequired min 2, up to 2

supply_area

path: map/supplyareas
fielddescriptionrequiredrhs
idRequiredInteger
nameRequiredLocalisation key
valueRequiredInteger
statesRequiredblock, containing:
<state>Required, many

tech_sharing_group

path: common/technology_sharing
fielddescriptionrequiredrhs
idRequiredScalar
nameRequiredLocalisation key
descRequiredLocalisation key
pictureRequired<spriteType>
research_sharing_per_country_bonusRequiredFloat
is_faction_sharingOptionalyes
categories Categories for tech.Optionalblock, containing:
Recommended, many
availableOptionaltrigger block

technology

(+) Subtypes

path: common/technologies
fielddescriptionrequiredrhs
doctrine_nameOptionalLocalisation key
show_equipment_iconOptionalyes/no
descOptionalLocalisation key
xp_research_typeOptionalarmy, navy, air
xp_research_costOptionalInteger
xp_research_bonusOptionalFloat
enable_tacticOptional, many<combat_tactic>
research_cost Multiplier to base tech cost in defines.luaRequiredFloat
start_year When ahead of time penalty reaches 0.OptionalInteger
sub_tech_indexOptionalInteger
doctrine Is a doctrine.Optionalyes/no
show_effect_as_descOptionalyes/no
nuclear_productionOptionalFloat
Requiredmodifier fields
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
allow Hides technology unless trigger is true.Optionaltrigger block
allow_branch Hides technology and children unless trigger is true.Optionaltrigger block
xor Make technology exclusive with techs named.Optionalblock, containing:
<technology>Recommended, many
enable_subunits Enables listed units.Optionalblock, containing:
<unit>Recommended, many
enable_equipments Enables listed equipment.Optionalblock, containing:
<equipment>Recommended, many
enable_equipment_modules Enables listed equipment modules.Optional, manyblock, containing:
<module>Recommended, many
enable_building Sets max level of named building.Optionalblock, containing:
buildingRequired<building>
levelRequiredInteger
sub_technologies Technologies directly dependent on this tech.Optionalblock, containing:
<technology>Recommended, up to 3
path Techs following this.Optional, manyblock, containing:
leads_to_techOptional<technology>
research_cost_coeffRequiredFloat
dependenciesOptionalblock, containing:
<technology>Recommended, manyInteger
folder Which folder(s) tech appears in.Optional, manyblock, containing:
nameRequired
positionRequiredblock, containing:
xRequiredFloat
yRequiredFloat
ai_will_do AI weights for research.Optionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
ai_research_weights Modifies AI willingness for categories.Optionalblock, containing:
defensive, offensive, carrier, battleship, cruiserOptional, manyFloat
Optional, manyFloat
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, cavalry, mechanized, armor, fighter, cas, naval_bomber, interceptor, suicide, tactical_bomber, strategic_bomber, air_transport, missile, submarine, screen_ship, capital_ship, carrier, convoy, paratroopers, scout_planeOptional, manyFloat
<resource>Optional, manyFloat
categories Categories for tech.Optionalblock, containing:
Recommended, many
Optional, manyblock, containing:
Optional, manyunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
<unit>Optional, manyblock, containing:
Optional, manyunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
needOptional, manyblock, containing:
<equipment>Required, manyInteger
modifierOptionalmodifier block
on_research_complete_limitOptionaltrigger block
on_research_completeOptionaleffect block

terrain

(+) Subtypes

path: common/terrain
fielddescriptionrequiredrhs
colorRequiredblock, containing:
IntegerRequired min 3, up to 3
movement_cost of subtype unknownRequiredFloat
sound_type of subtype unknownRequiredScalar
naval_terrain of subtype waterOptionalyes
is_water of subtype waterRequiredyes
Requiredunit_stat fields
<unit> of subtype ship_unitOptional, manyblock, containing:
Requirednaval_stat fields
units of subtype waterOptionalunit_stat block
naval_terrain of subtype naval_terrainRequiredyes
is_water of subtype naval_terrainRequiredyes
Requiredunit_stat fields
<unit> of subtype ship_unitOptional, manyblock, containing:
Requirednaval_stat fields
units of subtype naval_terrainOptionalunit_stat block
combat_width, attrition, enemy_army_bonus_air_superiority_factor, sickness_chanceOptional, manyFloat
ai_terrain_importance_factor of subtype landRequiredFloat
match_value of subtype landRequiredFloat
units of subtype landOptionalunit_stat block

unit

(+) Subtypes

path: common/units
fielddescriptionrequiredrhs
sprite 3D map asset.RequiredScalar
priority Weighting for mixed divisions.RequiredInteger
active Whether needs tech to create.Requiredyes/no
Requiredunit_stat fields
own_equipment_fuel_consumption_multOptionalFloat
ai_priority of subtype land_unitRequiredInteger
map_icon_category of subtype land_unit map iconRequiredinfantry, armored, other
cavalry of subtype land_unit CavalryOptionalyes/no
special_forces of subtype land_unit counts against special forces limitOptionalyes/no
marines of subtype land_unit Marines ooh-rahOptionalyes/no
mountaineers of subtype land_unit MountaineersOptionalyes/no
can_be_parachuted of subtype land_unit ParatroopersOptionalyes/no
transport of subtype land_unit use this equipment for speedOptional<equipment>
group of subtype land_unit division designer groupOptionalInline localisation key
need of subtype land_unitRequiredblock, containing:
<equipment>Recommended, manyInteger
type of subtype land_unit unit typeRequiredblock, containing:
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, mechanized, armorRecommended, many
ai_priority of subtype support_unitRequiredInteger
map_icon_category of subtype support_unit map iconRequiredinfantry, armored, other
cavalry of subtype support_unit Cavalry.Optionalyes/no
special_forces of subtype support_unit Counts against special forces limit.Optionalyes/no
marines of subtype support_unit Marines ooh-rah.Optionalyes/no
mountaineers of subtype support_unit Mountaineers.Optionalyes/no
can_be_parachuted of subtype support_unit Paratroopers.Optionalyes/no
transport of subtype support_unit Use this equipment for speed.Optional<equipment>
group of subtype support_unit Division designer group.OptionalInline localisation key
affects_speed of subtype support_unitOptionalno
same_support_type of subtype support_unit Blocks adding same unit types to a template.Optional<unit> of subtype support_unit
need of subtype support_unitRequiredblock, containing:
<equipment>Recommended, manyInteger
type of subtype support_unit Unit type.Requiredblock, containing:
infantry, support, artillery, rocket, anti_tank, anti_air, motorized, mechanized, armorRecommended, many
map_icon_category of subtype ship_unit Map icon.Requiredship, transport, uboat
Requirednaval_stat fields
critical_part_damage_chance_mult of subtype ship_unitRequiredFloat
hit_profile_mult of subtype ship_unitRequiredFloat
need of subtype ship_unitOptionalblock, containing:
<equipment>Recommended, manyInteger
need_equipment of subtype ship_unitOptionalblock, containing:
<equipment>Recommended, manyInteger
need_equipment_modules of subtype ship_unitOptionalblock, containing:
any of subtype ship_unitRequiredblock, containing:
<module>Required, manyInteger
type of subtype ship_unitRequiredblock, containing:
battle_cruiser, battleship, capital_ship, carrier, convoy, destroyer, heavy_cruiser, light_cruiser, screen_ship, submarineRecommended, many
critical_parts of subtype ship_unitRequiredblock, containing:
<critical_part>Recommended, many
Requiredair_stat fields
need of subtype air_unitRequiredblock, containing:
<equipment>Recommended, manyInteger
type of subtype air_unitRequiredblock, containing:
air_transport, cas, fighter, interceptor, missile, naval_bomber, scout_plane, strategic_bomber, suicide, tactical_bomberRecommended, many
test of subtype catchRequiredInteger
essentialOptionalblock, containing:
<equipment>Recommended, many
categoriesOptionalblock, containing:
Recommended, many

unit_leader_trait

(+) Subtypes

path: common/unit_leader
fielddescriptionrequiredrhs
typeRequiredall, corps_commander, field_marshal, navy, land, operative
trait_typeOptionalassignable_terrain_trait, basic_terrain_trait, personality_trait, assignable_trait, status_trait, exile, basic_trait
custom_effect_tooltipOptionalLocalisation key
override_effect_tooltipOptionalLocalisation key
enable_abilityOptional, up to 5<ability>
typeRequiredblock, containing:
all, corps_commander, field_marshal, navy, land, operativeRecommended, many
attack_skill, defense_skill, logistics_skill, planning_skill Direct bonus to this skill.Optional, up to 4Integer
attack_skill_factor, defense_skill_factor, logistics_skill_factor, planning_skill_factor Bonus for gaining this skill.Optional, up to 4Integer
gain_xp_on_spotting of subtype naval_commanderOptionalInteger
attack_skill_factor, coordination_skill_factor, maneuvering_skill_factor, planning_skill_factor Bonus for gaining this skill.Optional, up to 4Integer
sub_unit_modifiers of subtype naval_commanderOptionalblock, containing:
<unit>Required, manyblock, containing:
Requiredunit_stat fields
Requirednaval_stat fields
Requiredair_stat fields
cost of subtype gainable_traitRequiredInteger
gui_row of subtype gainable_traitRequiredInteger
gui_column of subtype gainable_traitOptionalInteger
custom_gain_xp_trigger_tooltip of subtype gainable_traitOptionalLocalisation key
gain_xp of subtype gainable_traitRequiredtrigger block, with scopes ROOT: Combat, FROM: Combat
gain_xp_leader of subtype gainable_traitRequiredtrigger block, with scopes ROOT: Unit Leader, FROM: Country
gui_row of subtype assignable_traitRequiredInteger
gui_column of subtype assignable_traitOptionalInteger
parent of subtype assignable_traitOptional, up to 5<unit_leader_trait>
mutually_exclusive of subtype assignable_traitOptional, up to 5<unit_leader_trait>
custom_prerequisite_tooltip of subtype assignable_traitOptionalLocalisation key
num_parents_needed of subtype assignable_traitOptionalInteger
prerequisites of subtype assignable_traitOptionaltrigger block
field_marshal_modifierOptionalblock, containing:
Requiredmodifier fields
Requiredunit_leader_modifier fields
corps_commander_modifierOptionalblock, containing:
Requiredmodifier fields
Requiredunit_leader_modifier fields
allowedOptionaltrigger block
modifierOptionalblock, containing:
Requiredmodifier fields
Requiredunit_leader_modifier fields
non_shared_modifierOptionalblock, containing:
Requiredmodifier fields
Requiredunit_leader_modifier fields
new_commander_weightOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields
trait_xp_factorOptionalblock, containing:
<unit_leader_trait>RequiredFloat
ai_will_doOptionalblock, containing:
base, factorOptionalFloat
Requiredmodifier_rule fields

upgrade

(+) Subtypes

path: common/units/equipment/upgrades
fielddescriptionrequiredrhs
max_levelRequiredInteger
Requiredunit_stat fields
cost of subtype naval_upgradeRequirednaval
Requirednaval_stat fields
cost of subtype air_upgradeRequiredair
Requiredair_stat fields
cost of subtype land_upgradeRequiredland

wargoal

path: common/wargoals
fielddescriptionrequiredrhs
war_nameOptionalLocalisation key
generate_base_costOptionalInteger
generate_per_state_costOptionalInteger
take_states_limitOptionalInteger
take_states_costOptionalInteger
puppet_costOptionalInteger
annex_threat_factorOptionalFloat
annex_costOptionalInteger
force_government_costOptionalInteger
expireOptionalInteger
threatOptionalFloat
allowedOptionaltrigger block
availableOptionaltrigger block
take_statesOptionaltrigger block, with scopes ROOT: Country
puppetOptionaltrigger block
liberateOptionaltrigger block