HOI4DOC

https://hoi4doc.dev
Admin
HOI4DOC is a modern, lightweight documentation wiki providing searchable information on Hearts of...
Tokens:296,841
Snippets:5,305
Trust Score:4.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Math Expression Examples

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Basic syntax examples for performing arithmetic operations and comparisons within math expression blocks.

```text
{ value = num_cavalry
```

```text
add = num_motorized
```

```text
add = num_mechanized
```

```text
greater_than = { value = num_units  multiply = 0.4 }
```

--------------------------------

### Set Occupation Law Examples

Source: https://hoi4doc.dev/item/effect-set_occupation_law

Examples demonstrating how to set specific occupation laws, reset laws to default, and apply laws to specific states.

```HOI4 Script
GER = { set_occupation_law = foreign_civilian_oversight }
```

```HOI4 Script
GER = { POL = { set_occupation_law = default_law } }
```

```HOI4 Script
GER = { 123 = { set_occupation_law = military_governor_occupation } }
```

--------------------------------

### Example Usage of party_leader

Source: https://hoi4doc.dev/item/effect-party_leader

This example targets communist characters and sets a character flag on them.

```pdx
party_leader = {
	limit = { has_ideology = communism }
	set_character_flag = whatever_flag
}
```

--------------------------------

### every_country_division Usage Example

Source: https://hoi4doc.dev/item/effect-every_country_division

Example demonstrating the structure of the every_country_division effect, including optional parameters for tooltips, random selection, and individual scope display.

```text
SOV = {
	every_country_division = {
		tooltip = my_loc_key # Optional
		random_select_amount = 3 # Optional
		display_individual_scopes = yes # Optional - default = no
		... division scope effects ...
	}
}
```

--------------------------------

### Manpower Per Military Factory Trigger Example

Source: https://hoi4doc.dev/browse

Example usage for checking available manpower per military factory.

```text
manpower_per_military_factory < 1000
```

--------------------------------

### every_subject_country Usage Example

Source: https://hoi4doc.dev/item/effect-every_subject_country

Example demonstrating the structure of the effect, including optional parameters for random selection and individual scope display.

```pdx
SOV = {
	every_subject_country = {
		tooltip = my_loc_key # Optional
		random_select_amount = 3 # Optional
		display_individual_scopes = yes # Optional - default = no
		... country scope effects ...
	}
}
```

--------------------------------

### State Modifier Examples

Source: https://hoi4doc.dev/category/state

Examples of various state-level modifiers used to adjust building limits, production speeds, and resource amounts.

```text
starting_compliance = 0.3
```

```text
state_bunker_max_level_terrain_limit = 6
```

```text
state_coastal_bunker_max_level_terrain_limit = 6
```

```text
state_production_speed_industrial_complex_factor = 0.3
```

```text
state_repair_speed_industrial_complex_factor = 0.3
```

```text
state_resource_cost_rubber = 5
```

```text
state_resource_oil = 5
```

```text
state_resources_factor = 0.2
```

--------------------------------

### Modifier Examples

Source: https://hoi4doc.dev/browse

Examples of applying rangers_special_forces_contribution_factor and reassignment_duration_factor modifiers.

```text
rangers_special_forces_contribution_factor = 0.3
```

```text
reassignment_duration_factor = 0.5
```

--------------------------------

### Set MIO Funds

Source: https://hoi4doc.dev/category/economic

Example of setting the current funds for an MIO.

```HOI4 Script
var:my_mio_var = {
	set_mio_funds = 100
	set_mio_funds = var:my_number_var
}
```

--------------------------------

### Check Variable Conditions

Source: https://hoi4doc.dev/browse

Examples of checking variable values against constants or other variables.

```text
check_variable = { varname = 0 }
```

```text
check_variable = { varname > 12 }
```

```text
check_variable = { varname < 42 }
```

```text
check_variable = { varname > another_varname }
```

--------------------------------

### Create Equipment Variant Example

Source: https://hoi4doc.dev/item/effect-create_equipment_variant

Defines a new equipment variant with specific modules, upgrades, and configuration settings.

```text
create_equipment_variant = {
	name = "Yorktown Class" # Optional.
	name_group = USA_CV_HISTORICAL # Optional. If not set, parent's name group will be inherited.
	type = ship_hull_carrier_1 # Must be a type and not an archetype.
	allow_without_tech = yes # Optional. Default no. If yes, create the variant even if the type hasn't been unlocked yet. Otherwise created the variant once the type research completes.
	parent_version = 3 # Default 0. If not found the default variant will be used (or created).
	obsolete = yes # Optional. Default no.
	mark_older_equipment_obsolete = yes # Optional. Default no. Marks all older (non-chassis) equipment variants as obsolete as long as the following matches: Archetype, niche, mission set (for planes).
	role_icon_index = 3 # Optional. Default 'auto', leverage AI design logic.
	upgrades = { # Optional. The level on each upgrade is inherited from the parent.
		ship_deckspace_upgrade = 1
		carrier_armor_upgrade = 2
	}
	modules = { # Optional. The module installed in each slot is inherit from the parent.
		fixed_ship_engine_slot = carrier_ship_engine_2
		fixed_ship_secondaries_slot = empty # Clears the slot if the parent has any module installed.
	}
	model = "GER_light_armor_2_entity" # Optional.
	icon = "gfx/interface/technologies/ger_basic_light_tank.dds" # Optional. GFX names are also supported e.g. "GFX_GER_basic_light_tank_medium".
	design_team = mio:my_mio_token # Optional. accepts mio:token, variable or keyword
}
```

--------------------------------

### State Modifier Examples

Source: https://hoi4doc.dev/browse

Examples of various state-level modifiers used to adjust building slots, resources, and supply impacts.

```text
local_building_slots = 2
```

```text
local_building_slots_factor = 0.3
```

```text
local_factories = 0.3
```

```text
local_factory_energy_consumption = 0.2
```

```text
local_factory_energy_consumption_per_infrastructure = 0.2
```

```text
local_factory_sabotage = 0.3
```

```text
local_intel_to_enemies = 0.3
```

```text
local_manpower = 0.3
```

```text
local_non_core_manpower = 0.3
```

```text
local_non_core_supply_impact_factor = 0.3
```

```text
local_org_regain = -0.3
```

```text
local_resource_gain_efficiency_per_infrastructure = 0.3
```

```text
local_resources = 0.3
```

```text
local_resources_factor = 0.3
```

```text
local_supplies = 0.3
```

```text
local_supplies_for_controller = 0.3
```

```text
local_supply_impact_factor = 0.3
```

```text
marines_special_forces_contribution_factor = 0.3
```

--------------------------------

### Set MIO Icon

Source: https://hoi4doc.dev/category/economic

Example of assigning a GFX icon to an MIO.

```HOI4 Script
mio:my_mio = {
	set_mio_icon = MY_NEW_MIO_ICON_GFX
}
```

--------------------------------

### Logistics Skill Level Trigger Example

Source: https://hoi4doc.dev/browse

Example usage for comparing the logistics skill level of a unit leader.

```text
logistics_skill_level > 5
```

--------------------------------

### Apply supply_units effect

Source: https://hoi4doc.dev/item/effect-supply_units

Usage example for the supply_units effect within a script.

```text
supply_units = 24
```

--------------------------------

### Formatted Localization Usage

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Examples of using formatted localization with formatters, standard keys, and localization scope objects.

```text
# Using a  formatter
custom_effect_tooltip = idea_desc|canadian_pacific_railway

# Using a standard loc key
custom_effect_tooltip = WHILE_FOCUSING

# Using a loc string with a localization scope object
custom_effect_tooltip = "[ROOT.GetName]"
```

--------------------------------

### Intel Level Over Trigger

Source: https://hoi4doc.dev/browse

Example of comparing intel levels between countries.

```text
GER = {
	# is true if all predicates are satisfied
	intel_level_over = {
		target = POL
		civilian_intel > 0.5  # GER has more than 50% civ. intel over POL
		army_intel = 0  # GER has no army intel over POL
		navy_intel > 0  # GER has at least some navy intel over POL
		# airforce_intel is not specified and thus ignored in the comparison
```

--------------------------------

### has_start_date

Source: https://hoi4doc.dev/item/trigger-has_start_date

A trigger used to compare the initial start date of the current game.

```APIDOC
## has_start_date

### Description
Compare the initial start date of the current game.

### Supported Scopes
- any

### Categories
- Country
```

--------------------------------

### Set Keyed OOB

Source: https://hoi4doc.dev/category/naval

Registers an Order of Battle file for a country at game start, intended for history files.

```text
set_keyed_oob = {
	key = naval
	name = "ENG_1936_Naval"
}
```

--------------------------------

### has_contested_owner Usage Examples

Source: https://hoi4doc.dev/item/trigger-has_contested_owner

Demonstrates checking contested ownership from both state and country scopes.

```text
42 = {
	has_contested_owner = GER
}
```

```text
GER = {
	has_contested_owner = 42
}
```

--------------------------------

### Modifier Examples

Source: https://hoi4doc.dev/browse

Various modifiers used to adjust game values.

```text
improve_relations_maintain_cost_factor = 0.5
```

```text
industrial_capacity_dockyard = 0.3
```

```text
industrial_capacity_factory = 0.3
```

```text
industrial_factory_donations = 2
```

```text
industry_air_damage_factor = 0.3
```

```text
industry_free_repair_factor = 0.3
```

```text
industry_repair_factor = 0.3
```

```text
initiative_factor = 0.3
```

```text
intel_from_combat_factor = 0.3
```

```text
intel_from_operatives_factor = 0.3
```

--------------------------------

### Advisor Slot Availability Configuration

Source: https://hoi4doc.dev/item/trigger-not_already_hired_except_as

Example usage within advisor definitions to ensure mutual exclusivity between roles.

```text
advisor = {
	slot = political_advisor
	available = { not_already_hired_except_as = political_advisor }
	...
}
```

```text
advisor = {
	slot = theorist
	available = { not_already_hired_except_as = theorist }
	...
}
```

--------------------------------

### Set State Controller Example

Source: https://hoi4doc.dev/item/effect-set_state_controller_to

Changes the controller of a random core state to the country with the tag JAM.

```HOI4 Script
random_core_state = {
	set_state_controller_to = JAM
}
```

--------------------------------

### Define Equipment and Conversion Modifiers

Source: https://hoi4doc.dev/browse

Examples of setting modifiers related to equipment capture, conversion speed, and upgrade costs.

```text
equipment_capture = 0.2
```

```text
equipment_capture_factor = 0.5
```

```text
equipment_capture_factor_for_controller = 0.3
```

```text
equipment_capture_for_controller = 0.3
```

```text
equipment_conversion_speed = 0.5
```

```text
equipment_upgrade_xp_cost = 0.5
```

--------------------------------

### Set MIO Name Key

Source: https://hoi4doc.dev/category/economic

Example of setting the localization key for an MIO's name.

```HOI4 Script
mio:my_mio = {
	set_mio_name_key = MY_NEW_MIO_NAME_KEY
}
```

--------------------------------

### Check Unit Count

Source: https://hoi4doc.dev/browse

Example of checking the number of units commanded by a unit leader.

```text
num_units > 2
```

--------------------------------

### Check Factory Count

Source: https://hoi4doc.dev/category/economic

Example of checking the number of available factories for a country.

```HOI4 Script
GER = { num_of_factories < 50 }
```

--------------------------------

### Define Modifier Values

Source: https://hoi4doc.dev/browse

Examples of setting various game modifiers using percentage or flat values.

```text
sickness_chance = 0.5
```

```text
skill_bonus_factor = 0.5
```

```text
sortie_efficiency = 0.3
```

```text
special_forces_cap = 0.5
```

```text
special_forces_cap_flat = 10
```

```text
special_forces_min = 250
```

```text
special_forces_no_supply_grace = 120
```

```text
special_forces_out_of_supply_factor = 0.3
```

```text
special_forces_training_time_factor = 0.3
```

```text
spotting_chance = 0.3
```

```text
stability_factor = 0.3
```

```text
stability_weekly = 0.01
```

```text
stability_weekly_factor = 0.3
```

--------------------------------

### Add Faction Power Projection Example

Source: https://hoi4doc.dev/item/effect-add_faction_power_projection

Adds 100 power projection to the faction of the target country.

```HOI4 Script
TAG = {
	add_faction_power_projection = 100
}
```

--------------------------------

### Set MIO Flag

Source: https://hoi4doc.dev/category/economic

Example of setting a flag on an MIO, with optional value and duration parameters.

```HOI4 Script
var:my_mio_var = {
	set_mio_flag = my_flag
	set_mio_flag = {
		flag = my_flag (mandatory)
		value = 3 (optional, default = 1)
		days = 12 (optional, default = 0. if > 0, the flag will be deleted after this number of days)
	}
}
```

--------------------------------

### Modify Project Flag Example

Source: https://hoi4doc.dev/item/effect-modify_project_flag

Updates an existing project flag to a new numeric value.

```text
modify_facility_flag = { flag = <name> value = <number> }
```

--------------------------------

### Create Intelligence Agency with Default Settings

Source: https://hoi4doc.dev/item/effect-create_intelligence_agency

Initializes an intelligence agency using historical defaults if available.

```text
create_intelligence_agency = yes # creates with historical ones, if exists.
```

--------------------------------

### is_scientist_injured Usage Example

Source: https://hoi4doc.dev/item/trigger-is_scientist_injured

Example usage of the trigger within a character scope.

```text
my_character = {
	is_scientist_active = yes
}
```

--------------------------------

### is_active_scientist Usage Example

Source: https://hoi4doc.dev/item/trigger-is_active_scientist

Example usage of the trigger within a character scope block.

```text
my_character = {
	is_scientist_active = yes
	is_scientist_active = no
}
```

--------------------------------

### Create Intelligence Agency with Custom Name and Icon

Source: https://hoi4doc.dev/item/effect-create_intelligence_agency

Initializes an intelligence agency with a specified name and graphical icon.

```text
create_intelligence_agency = {
	name = "M.I.B."
	icon = "GFX_intelligence_agency_logo_ita"
}
```

--------------------------------

### Start Resistance

Source: https://hoi4doc.dev/category/state

Starts resistance activity for a core country or enables it in a state.

```HOI4 Script
start_resistance = POL or start_resistance = yes
```

--------------------------------

### is_tutorial

Source: https://hoi4doc.dev/item/trigger-is_tutorial

A trigger that returns true if the tutorial is active.

```APIDOC
## is_tutorial

### Description
Checks if the tutorial mode is currently active.

### Supported Scopes
- any

### Supported Targets
- none

### Categories
- Country
```

--------------------------------

### Start a Peace Conference

Source: https://hoi4doc.dev/category/political

Starts a limited peace conference between the winner (ROOT) and a specified loser country.

```HOI4 Script
SOV = {
	start_peace_conference = {
		tag = FIN  # main loser
		score_factor = 0.2  # 0-1, the fraction of conference score allocated to winners. Can use a variable like eg PREV.surrender_progress. 0.0 implies a white peace.

		# winner_scope and loser_scope can be ALL (all relevant countries), FACTION (members of main country's faction and overlordship), LIMITED_FACTION (faction members if main country is faction leader, and subjects if main country is overlord), and LIMITED (main country and their subjects)
		winner_scope = FACTION  # optional, default is LIMITED_FACTION
		loser_scope = FACTION  # optional, default is LIMITED_FACTION
		message = FIN_agree_peace  # optional, custom message to display in post-conference popup
	}
}
```

--------------------------------

### Define collections with shorthand

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Demonstrates the equivalent syntax between a full collection object and the shorthand input-only notation.

```text
my_collection = {
	input = game:all_states
}

my_collection = game:all_states
```

--------------------------------

### Use idea_desc formatter

Source: https://hoi4doc.dev/item/documentation-loc_formatter_documentation?tab=usage

Retrieves the description for a specific idea. Requires a Country scope.

```text
custom_effect_tooltip = idea_desc|canadian_pacific_railway
```

--------------------------------

### Promote Character in Character Scope

Source: https://hoi4doc.dev/item/effect-promote_character

Usage examples for promoting a character when the scope is already set to the character.

```HOI4 Script
promote_character = yes
```

```HOI4 Script
promote_character = nazism
```

```HOI4 Script
promote_character = {
	ideology = nazism
}
```

--------------------------------

### Create a Faction from Template

Source: https://hoi4doc.dev/category/country

Creates a faction from a template, with optional support for custom names, icons, and colors.

```text
TAG = { # Creator's tag
	create_faction_from_template = faction_template_id
}
```

```text
Tag = { # Creator's tag

	create_faction_from_template = {
		template = faction_template_id
		name = FACTION_NAME_LOC_ID
		icon = GFX_faction_icon
		color = { 0.5 0.5 0.5 }
	}
}
```

--------------------------------

### Add Nationality Effect Examples

Source: https://hoi4doc.dev/item/effect-add_nationality

Use these examples to assign a nationality to an operative using either a scope or a country tag.

```HOI4 Script
add_nationality = ROOT
```

```HOI4 Script
add_nationality = FRA
```

--------------------------------

### Use advisor_desc formatter

Source: https://hoi4doc.dev/item/documentation-loc_formatter_documentation?tab=usage

Retrieves the description for a specific advisor. Requires a Country scope.

```text
custom_effect_tooltip = advisor_desc|hjalmar_schacht
```

--------------------------------

### Define Simple Bindable Localization

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Use a simple localization key for a tooltip.

```text
tooltip = MY_TOOLTIP # Simple loc key tooltip

### Loc entries
MY_TOOLTIP = "This is a tooltip"

### Localized result
This is a tooltip
```

--------------------------------

### Use idea_name formatter

Source: https://hoi4doc.dev/item/documentation-loc_formatter_documentation?tab=usage

Retrieves the name for a specific idea. Requires a Country scope.

```text
custom_effect_tooltip = idea_name|canadian_pacific_railway
```

--------------------------------

### Load Order of Battle

Source: https://hoi4doc.dev/category/country

Immediately loads an Order of Battle (OOB) file.

```text
load_oob = "ENG_1936"
```

--------------------------------

### has_dlc

Source: https://hoi4doc.dev/item/trigger-has_dlc

A trigger that checks if the player has a specific DLC installed.

```APIDOC
## has_dlc

### Description
Checks if the player has a specific DLC.

### Syntax
`has_dlc = "name of the dlc"`

### Supported Scopes
- any

### Categories
- Country
```

--------------------------------

### Define Intelligence and Combat Modifiers

Source: https://hoi4doc.dev/type/modifier

Examples of modifiers affecting intelligence decryption, combat width, and command power.

```text
civilian_intel_decryption_bonus = 0.5
```

```text
civilian_intel_to_others = 0.5
```

```text
coastal_bunker_effectiveness_factor = 0.1
```

```text
combat_width_factor = 0.3
```

```text
command_abilities_cost_factor = -0.3
```

```text
command_power_gain = 0.5
```

```text
command_power_gain_mult = 0.5
```

--------------------------------

### Use Script Constants

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Reference defined constants in script files using the constant prefix or direct assignment.

```text
some_scoped_variable = constant:numeric_constants.pi
some_fixed_point_supporting_constants = numeric_constants.e
```

--------------------------------

### Stability Modifiers

Source: https://hoi4doc.dev/category/country

Examples of applying stability-related modifiers to a country.

```HOI4 Script
stability_factor = 0.3
```

```HOI4 Script
stability_weekly = 0.01
```

```HOI4 Script
stability_weekly_factor = 0.3
```

```HOI4 Script
starting_compliance = 0.3
```

--------------------------------

### start_peace_conference

Source: https://hoi4doc.dev/browse

Starts a limited peace conference between the two countries if at war.

```APIDOC
## start_peace_conference

### Description
Starts a limited peace conference between the two countries if at war. Only the specified loser country and their potential subjects are included as losers in the conference. ROOT is the winner while the target tag is the loser.

### Parameters
- **tag** (string) - Required - The main loser country tag.
- **score_factor** (float) - Required - The fraction of conference score allocated to winners (0-1).
- **winner_scope** (string) - Optional - Scope for winners (ALL, FACTION, LIMITED_FACTION, LIMITED). Default: LIMITED_FACTION.
- **loser_scope** (string) - Optional - Scope for losers (ALL, FACTION, LIMITED_FACTION, LIMITED). Default: LIMITED_FACTION.
- **message** (string) - Optional - Custom message to display in post-conference popup.

### Request Example
SOV = {
	start_peace_conference = {
		tag = FIN
		score_factor = 0.2
		winner_scope = FACTION
		loser_scope = FACTION
		message = FIN_agree_peace
	}
}
```

--------------------------------

### Starting Compliance Modifier

Source: https://hoi4doc.dev/browse

Modifies the base compliance value for a state.

```text
starting_compliance = 0.3
```

--------------------------------

### Set Politics

Source: https://hoi4doc.dev/category/political

Configures ruling party, election status, and party names.

```text
ruling_party = key of new ruling ideology
```

```text
elections_allowed = yes/no
```

```text
long_name = loc_key
```

```text
name = loc_key
```

--------------------------------

### Load Focus Tree

Source: https://hoi4doc.dev/category/country

Sets the focus tree for a country, with options to retain or copy completed focuses.

```text
load_focus_tree = {
	tree = persian_focus_tree
	copy_completed_from = PER
}
```

--------------------------------

### Usage of has_artillery_ratio

Source: https://hoi4doc.dev/item/trigger-has_artillery_ratio

Example syntax for checking if the artillery ratio is greater than 0.1.

```text
has_artillery_ratio > 0.1
```

--------------------------------

### any_unit_leader Trigger Syntax

Source: https://hoi4doc.dev/item/trigger-any_unit_leader

Basic syntax for the any_unit_leader trigger, including optional tooltip and visibility parameters.

```text
tooltip=key can be defined to override title.
```

```text
GER = {
	any_unit_leader = {
		tooltip = my_loc_key # Optional
		include_invisible = yes # Optional - default = no
		... character scope triggers ...
	}
}
```

--------------------------------

### Get Supply Vehicles

Source: https://hoi4doc.dev/category/country

Retrieves the count of supply vehicles in stockpile or required.

```text
get_supply_vehicles = {
	var = num_vehicles #variable to set
	type = truck #can be truck or train
	need = yes #default no. If yes, gets the number of needed vehicles
}
```

```text
get_supply_vehicles_temp = {
	var = num_vehicles #variable to set
	type = truck #can be truck or train
	need = yes #default no. If yes, gets the number of needed vehicles
}
```

```text
get_supply_vehicles_temp = {
	var = num_vehicles #variable to set
	type = truck #can be truck or train
	need = yes #default no. If yes, gets the number of needed vehicles
}
```

--------------------------------

### has_scientist_level Example

Source: https://hoi4doc.dev/item/trigger-has_scientist_level

Demonstrates checking if a character has a nuclear specialization level greater than 2.

```pdx
my_character = {
	has_scientist_level = {
		level > 2
		specialization = specialization_nuclear
	}
}
```

--------------------------------

### Define Nested Bindable Localization

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Create complex tooltips by nesting bound localization objects with parameters.

```text
tooltip = {
	localization_key = MY_TOOLTIP # Root look key
	IMPORTANT_QUESTION = { # ID IMPORTANT_QUESTION in MY_TOOLTIP will get value:
		localization_key = MEANING_OF_LIFE # Root loc key in IMPORTANT_QUESTION
		ANSWER = "42" # ID ANSWER in IMPORTANT_QUESTION will get value 42
	}
	THE_REST_IS = UNIMPORTANT
}

### Loc entries
MY_TOOLTIP = "The thing everyone wonders is if $IMPORTANT_QUESTION$. The rest is $THE_REST_IS$."
MEANING_OF_LIFE = "the meaning of life is $ANSWER$"
UNIMPORTANT = "unimportant"

### Result
The thing everyone wonders is if the meaning of life is 42. The rest is unimportant.
```

--------------------------------

### Poisson distribution configuration

Source: https://hoi4doc.dev/item/effect-randomize_temp_variable

Configuring the effect with a poisson distribution.

```text
var = num_dogs
```

```text
distribution = poisson
```

```text
lambda = 10           # required
```

```text
min = 10              # optional
```

--------------------------------

### Intelligence Network Modifiers

Source: https://hoi4doc.dev/browse

Examples of modifiers affecting intelligence network gain and counter-intelligence.

```text
intel_network_gain = 0.3
```

```text
intel_network_gain_factor = 0.3
```

```text
intelligence_agency_defense = 0.3
```

--------------------------------

### any_purchase_contract Trigger Syntax

Source: https://hoi4doc.dev/item/trigger-any_purchase_contract

Defines the structure for using the any_purchase_contract trigger, including the optional tooltip override.

```text
tooltip=key can be defined to override title.
```

```text
GER = {
	any_purchase_contract = {
		tooltip = my_loc_key # Optional
		... Purchase Contract scope triggers ...
	}
}
```

--------------------------------

### Compliance and Conscription Modifiers

Source: https://hoi4doc.dev/browse

Examples of modifiers affecting compliance growth and conscription rates.

```text
compliance_gain = 0.01
```

```text
compliance_growth = 0.5
```

```text
compliance_growth_on_our_occupied_states = 0.5
```

```text
conscription = 0.02
```

```text
conscription_factor = 0.3
```

--------------------------------

### Add Faction Goal Syntax

Source: https://hoi4doc.dev/item/effect-add_faction_goal

Use this syntax within a country scope to assign a faction goal by its ID.

```text
TAG = {
	add_faction_goal = faction_goal_id
}
```

--------------------------------

### Define breakthrough modifiers

Source: https://hoi4doc.dev/browse

Examples of applying breakthrough bonuses or factors as percentage modifiers.

```text
breakthrough_bonus_against = 0.5
```

```text
breakthrough_factor = 0.3
```

--------------------------------

### Define Country Modifiers

Source: https://hoi4doc.dev/category/country

Examples of various flat and percentage-based modifiers for country mechanics.

```text
join_faction_tension = 0.3
```

```text
justify_war_goal_time = 0.3
```

```text
justify_war_goal_when_in_major_war_time = 0.3
```

```text
land_bunker_effectiveness_factor = 0.1
```

```text
land_doctrine_cost_factor = -0.05
```

```text
land_equipment_upgrade_xp_cost = 0.3
```

```text
land_reinforce_rate = 0.3
```

```text
lend_lease_tension = 0.3
```

```text
lend_lease_tension_with_overlord = 0.3
```

```text
license_infantry_eq_production_speed_factor = 0.5
```

```text
license_production_speed = 0.5
```

```text
license_purchase_cost = 0.5
```

```text
license_tech_difference_speed = 0.5
```

```text
line_change_production_efficiency_factor = 0.3
```

--------------------------------

### show_mio_tooltip

Source: https://hoi4doc.dev/item/effect-show_mio_tooltip

Displays the name of the specified MIO and its initial trait within the game interface.

```APIDOC
## show_mio_tooltip

### Description
Displays the name of the input MIO with the name of the initial trait (if any).

### Scope
COUNTRY

### Usage
```
SOV = {
	show_mio_tooltip = my_mio_token
	show_mio_tooltip = var:my_mio_var
}
```
```

--------------------------------

### Country Modifier Definitions

Source: https://hoi4doc.dev/category/country

Examples of various country modifiers and their syntax for script files.

```text
embargo_cost_factor = 0.3
```

```text
embargo_threshold_factor = 0.2
```

```text
encryption = 1
```

```text
encryption_factor = 0.5
```

```text
enemy_declare_war_tension = 0.5
```

```text
enemy_justify_war_goal_time = 0.5
```

```text
enemy_operative_capture_chance_factor = 0.5
```

```text
enemy_operative_detection_chance = 10
```

```text
enemy_operative_detection_chance_factor = 0.5
```

```text
enemy_operative_detection_chance_factor_over_occupied_tag = 0.5
```

```text
enemy_operative_detection_chance_over_occupied_tag = 5
```

```text
enemy_operative_forced_into_hiding_time_factor = 0.5
```

```text
enemy_operative_harmed_time_factor = 0.5
```

```text
enemy_operative_intel_extraction_rate = 0.5
```

```text
enemy_spy_negative_status_factor = 0.5
```

```text
equipment_capture = 0.2
```

```text
equipment_capture_factor = 0.5
```

```text
equipment_conversion_speed = 0.5
```

```text
equipment_upgrade_xp_cost = 0.5
```

--------------------------------

### Check days_since_capitulated

Source: https://hoi4doc.dev/category/country

Examples of checking how long a country has been capitulated, recommended for use with has_capitulated.

```text
HOL = { has_capitulated = yes days_since_capitulated > 60 } # The Netherlands has been capitulated for more than two months
```

```text
FRA = { has_capitulated = yes days_since_capitulated < 21 } # France has capitulated sometime within the past three weeks
```

```text
GER = { OR = { has_capitulated = no days_since_capitulated > 14 } } # Germany is not both actively and recently capitulated
```

--------------------------------

### create_ship

Source: https://hoi4doc.dev/item/effect-create_ship

Creates a ship from another country and assigns it to the reserve fleet.

```APIDOC
## create_ship

### Description
Creates a ship from another country and assigns it to the reserve fleet. The 'creator' is optional and defaults to the scoped country if not set. The 'name' is also optional.

### Supported Scopes
COUNTRY

### Parameters
- **type** (string) - Required - The type of ship hull (e.g., ship_hull_submarine_1).
- **equipment_variant** (string) - Required - The name of the equipment variant.
- **creator** (string) - Optional - The country tag of the creator.
- **name** (string) - Optional - The name of the ship.
- **amount** (integer) - Required - The number of ships to add.

### Example
```
FRA = {
	create_ship = {
		type = ship_hull_submarine_1
		equipment_variant = "S Class"
		creator = ENG
		name = "My ship name"
		amount = 5
	}
}
```
```

--------------------------------

### Binomial distribution configuration

Source: https://hoi4doc.dev/item/effect-randomize_temp_variable

Configuring the effect with a binomial distribution.

```text
var = num_dogs
```

```text
distribution = binomial
```

```text
min = 0               # optional
```

```text
max = 10              # required if min is specified
```

--------------------------------

### Define State Modifiers

Source: https://hoi4doc.dev/category/state

Examples of percentual modifiers affecting resistance and garrison mechanics.

```text
required_garrison_factor = 0.5
```

```text
resistance_activity = 0.5
```

```text
resistance_damage_to_garrison = 0.3
```

```text
resistance_damage_to_garrison_on_our_occupied_states = 0.5
```

```text
resistance_decay = 0.3
```

```text
resistance_decay_on_our_occupied_states = 0.5
```

```text
resistance_garrison_penetration_chance = 0.3
```

```text
resistance_growth = 0.3
```

```text
resistance_growth_on_our_occupied_states = 0.5
```

```text
resistance_target = 0.3
```

```text
resistance_target_on_our_occupied_states = 0.5
```

--------------------------------

### Define Script Constants

Source: https://hoi4doc.dev/item/documentation-script_concept_documentation?tab=usage

Define numeric constants within a schema-based configuration file.

```text
numeric_constants = {
    schema = {
        any_key = yes
        data = fixed_point # floating point
    }
	pi = 3.14159
	e = 2.71828
}
```

--------------------------------

### Remove Buildings

Source: https://hoi4doc.dev/category/industrial

Examples of removing buildings using types, tags, or state/province scopes.

```text
remove_building = {
	type = air_base
	level = 1 # how many levels to remove
	state = 32 # or a variable like var:target_state
}
```

```text
remove_building = {
	tags = facility # can be a single tag or a { }-wrapped list of tags
	level = 1 # how many levels to remove
	province = 500 # or a variable like var:target_province
}
```

```text
remove_building = {
	type = air_base
	level = 1 # how many levels to remove
}
```

--------------------------------

### Using add_project_progress_ratio in a Special Project

Source: https://hoi4doc.dev/item/effect-add_project_progress_ratio

Demonstrates applying a fixed decimal value or a variable to a special project's progress ratio.

```HOI4 Script
sp:my_project = {
	add_project_progress_ratio = 0.1
	add_project_progress_ratio = var:my_var
}
```

--------------------------------

### Define Industrial Modifiers

Source: https://hoi4doc.dev/category/industrial

Examples of setting industrial complex and arms factory modifiers.

```text
production_cost_industrial_complex_factor = -0.1
```

```text
production_speed_industrial_complex_factor = 0.5
```

```text
repair_speed_arms_factory_factor = 0.5
```

--------------------------------

### Use country_leader_desc formatter

Source: https://hoi4doc.dev/item/documentation-loc_formatter_documentation?tab=usage

Retrieves the description for a country leader based on ideology. Supports IDEOLOGY and INDENT parameters.

```text
custom_effect_tooltip = country_leader_desc|hjalmar_schacht
```

```text
custom_effect_tooltip = {
	localization_key = country_leader_desc|hjalmar_schacht
	IDEOLOGY = token:fascism
	INDENT = 2_SPACES
```

--------------------------------

### Apply Economic Modifiers

Source: https://hoi4doc.dev/category/economic

Examples of applying various economic and cost-related modifiers.

```HOI4 Script
operation_infiltrate_cost = 0.5
```

```HOI4 Script
political_advisor_cost_factor = 0.5
```

```HOI4 Script
production_cost_industrial_complex_factor = -0.1
```

```HOI4 Script
production_cost_max_ship_hull_light = 0.3
```

--------------------------------

### game all_countries

Source: https://hoi4doc.dev/item/documentation-script_collection_input_documentation?tab=usage

Reference all existing countries, including governments in exile.

```APIDOC
## game all_countries

### Description
All existing countries (including government in exile).

### Example
```
has_resources_in_collection = {
	collection = game:all_countries
	resource = steel
	amount > 799
	extracted = yes
}
```
```

--------------------------------

### has_breakthrough_points Usage Example

Source: https://hoi4doc.dev/item/trigger-has_breakthrough_points

Checks if Germany has at least 1 breakthrough point in the nuclear specialization.

```pdx
GER = {
	has_breakthrough_points = {
		specialization = specialization_nuclear
		value = 1
	}
}
```

--------------------------------

### Define Modifiers

Source: https://hoi4doc.dev/browse

Examples of various flat and percentage-based modifiers applied to country or unit stats.

```text
join_faction_tension = 0.3
```

```text
justify_war_goal_time = 0.3
```

```text
justify_war_goal_when_in_major_war_time = 0.3
```

```text
land_bunker_effectiveness_factor = 0.1
```

```text
land_doctrine_cost_factor = -0.05
```

```text
land_equipment_upgrade_xp_cost = 0.3
```

```text
land_mastery_gain_factor = 0.15
```

```text
land_night_attack = 0.5
```

```text
land_reinforce_rate = 0.3
```

```text
legitimacy_daily = 1
```

```text
legitimacy_gain_factor = 1
```

```text
lend_lease_tension = 0.3
```

```text
lend_lease_tension_with_overlord = 0.3
```

--------------------------------

### Execute meta effect

Source: https://hoi4doc.dev/category/industrial

Builds and executes effects from strings.

```text
meta_effect = {
	text = {
		[COUNTRY] = {
			add_political_power = [POW]
		}
	}
	COUNTRY = "GER"
	POW = 42
	debug = no #set to yes if you want to see what game actually executes
}
```

--------------------------------

### Define Air Modifiers

Source: https://hoi4doc.dev/browse

Examples of common air force modifiers used in game files.

```text
air_strategic_bomber_night_penalty = 0.5
```

```text
air_superiority_bonus_in_combat = 0.5
```

```text
air_superiority_detect_factor = 0.5
```

```text
air_superiority_efficiency = 0.5
```

```text
air_training_xp_gain_factor = 0.5
```

```air_untrained_pilots_penalty_factor
air_untrained_pilots_penalty_factor = 0.5
```

```text
air_volunteer_cap = 100
```

```text
air_weather_penalty = 0.5
```

```text
air_wing_xp_loss_when_killed_factor = 0.5
```

--------------------------------

### Check building slots with free_building_slots

Source: https://hoi4doc.dev/category/industrial

Verifies available construction levels for a specific building type.

```text
free_building_slots = {
	building = building_type
	size > 5
	include_locked = yes # Optional - only to be used for buildings using Shared Slots.
	province = 42 #will check province buildings if specified
}
```

--------------------------------

### Modifier Examples

Source: https://hoi4doc.dev/category/country

Common modifiers for game mechanics like repair speed, lend-lease, and research.

```pdx
repair_speed_factor = 0.3
```

```pdx
request_lease_tension = 0.3
```

```pdx
required_garrison_factor = 0.5
```

```pdx
research_sharing_per_country_bonus = 0.5
```

```pdx
research_sharing_per_country_bonus_factor = 0.5
```

```pdx
research_speed_factor = 0.5
```

```pdx
resistance_activity = 0.5
```

```pdx
resistance_damage_to_garrison = 0.3
```

```pdx
resistance_damage_to_garrison_on_our_occupied_states = 0.5
```

```pdx
resistance_decay = 0.3
```

```pdx
resistance_decay_on_our_occupied_states = 0.5
```

```pdx
resistance_garrison_penetration_chance = 0.3
```

```pdx
resistance_growth = 0.3
```

```pdx
resistance_growth_on_our_occupied_states = 0.5
```

```pdx
resistance_target = 0.3
```

```pdx
resistance_target_on_our_occupied_states = 0.5
```

--------------------------------

### Apply country modifiers

Source: https://hoi4doc.dev/category/country

Examples of modifiers affecting manpower, combat experience, and trade factors.

```text
exiled_government_weekly_manpower = 100
```

```text
experience_loss_factor = 0.3
```

```text
extra_trade_to_target_factor = 0.5
```

```text
faction_trade_opinion_factor = 0.5
```

--------------------------------

### Apply add_faction_influence_ratio Effect

Source: https://hoi4doc.dev/item/effect-add_faction_influence_ratio

Example usage of the add_faction_influence_ratio effect within a country scope.

```HOI4 Script
TAG = {
	add_faction_influence_ratio = 0.1
}
```
Tokens:
Raw