Effects

From Paradox Modding Cooperation
Jump to: navigation, search

Effects (also known as Commands) are used in order to affect the game dynamically from within a specific scope.

Effects are used throughout the game in numerous scopes, most commonly National Focuses, Events and Decisions.

See Variables for information on the variable effects.

Note that certain effects may take a value from a variable, i.e.

add_manpower = var:my_var.

This is noted by <variable> in an effect's parameters.

Any Scope

Can be used in country, state or unit leader scopes.

New Man the Guns Effects

General

Name Parameters Examples Description Notes Version Added
remove_decision Allows to remove specified decision without running remove_effect. remove_decision = GER_MEPO Removes a decision.   1.6
swap_ruler_traits Similar to swap_ideas. Removes one trait and adds another. swap_ruler_traits = { remove = <trait> add = <trait> } Swaps traits.   1.6

remove_exile_tag

Remove the exile tag on a army leader, making them no longer be considered exile leaders. remove_exile_tag = { USA = "Arturo Rawson" } Removes a leaders exile tag.   1.6
add_legitimacy Adds legitimacy to a government in exile. add_legitimacy = 10 Adds legitimacy.   1.6

set_legitimacy

Sets the legitimacy of governments in exile. set_legitimacy= { POL = 1.0 } Sets legitimacy.   1.6
become_exiled_in Makes a country a government in exile in a set country, with a set starting legitimacy. become_exiled_in = { target = <Host tag> legitimacy = <0-1> starting legitimacy } Creates a government in exile. Must be fired from ROOT, the country that should be exiled, or a TAG specification must be used. 1.6
end_exile Ends a government in exile. end_exile Ends a government in exile.   1.6
add_province_modifier Adds a province modifier. add_province_modifier = { 5246 = mud } Adds a province modifier. New modifiers can be created in the "weather.txt" file. 1.6
remove_province_modifier Removes a province modifier. remove_province_modifier = { 5246 = mud } Removes a province modifier. New modifiers can be created in the "weather.txt" file. 1.6
set_faction_effect Sets a faction name the the loc name. set_faction_effect = SOME_LOC_KEY Changes faction names.   1.6
add_nuclear_bombs Adds nuclear bomb to TAG's stockpile. add_nuclear_bombs = 100 Changes faction names. Needs the Nuke tech to use. 1.6
launch_nuke Nukes a province.

launch_nuke = {
    province= 42
    state = 42

    controller = GER
    use_nuke = yes
}

Nukes a province.

When using state it nukes a random province in said state, with a preference to enemy occupied provinces.

Requires Nuke tech and nukes. Removes a nuke from stockpile when used. 1.6
inherit_technology Transfers all of a nations techs to a specified tag. inherit_technology = CAN Transfers tech. Useful in civil wars and when countries split. The target inherits the ROOT techs so make sure to specify what country that should be parented in case it is not fired by the intended ROOT. 1.6
set_fuel_ratio Set country's current fuel ratio relative to its capacity. set_fuel_ratio Sets country's current fuel ratio.   1.6
add_mines Add mines to a strategic region for the current country. add_mines = { region = 42 mines = 100 } Add mines to a strategic region.  

1.6

give_resource_rights Gives resource rights give_resource_rights = { receiver = ENG state = 291 } Gives all the resources of a state to the target country see 04_mtg_on_actions 1.6
remove_resource_rights Removes resource rights ENG = { remove_resource_rights = 477 } Removes given resource rights   1.6

Border War

Name Parameters Examples Description Notes Version Added
start_border_war change_state_after_war = <bool>
Whether the state changes hands after the war.

Attacker scope
state = <id> / <variable>
The attacker state.
num_provinces = <id>
The number of provinces used in the state.
on_win = <id>
The event to fire for the attacker on a win.
on_lose = <id>
The event to fire for the attacker on a loss.
on_cancel= <id>
The event to fire for the attacker on a draw.
Defender scope
state = <id> / <variable>
The defender state.
num_provinces = <id>
The number of provinces used in the state.
on_win = <id>
The event to fire for the defender on a win.
on_lose = <id>
The event to fire for the defender on a loss.
on_cancel= <id>
The event to fire for the defender on a draw.

start_border_war = {
    change_state_after_war = no
    attacker = {
        state = 527
        num_provinces = 4
        on_win = japan_border_conflict.2
        on_lose = japan_border_conflict.3
        on_cancel = japan_border_conflict.4
    }
				
    defender = {
        state = 408
        num_provinces = 4
        on_win = japan_border_conflict.3
        on_lose = japan_border_conflict.2
        on_cancel = japan_border_conflict.4
    }
}
Starts a border war for the specified attacker and defender. The participating countries are the owners of the specified states.   1.5
set_border_war_data attacker = <id> / <variable>
The attacker state.

defender = <id> / <variable>
The defender state.
attacker_modifier = <id> / <variable>
The modifier applied to attacker strength.
defender_modifier = <id> / <variable>
The modifier applied to attacker strength.
combat_width = <id> / <variable>
The combat width used in the border war battle.

set_border_war_data = {
    attacker = 527
    defender = 408
    defender_modifier = 0.15
    combat_width = 100
}
Sets the bonuses or penalties for the attacker and defender in an on-going border war. Used after start_border_war.   1.5
cancel_border_war attacker = <id> / <variable>
The attacker state.

defender = <id> / <variable>
The defender state.
dont_fire_events = <bool>
Stops the events from start_border_war from firing.

cancel_border_war = {
    dont_fire_events = yes
    defender = 408
    attacker = 527
}
Cancels an on-going border war without a winner.   1.5
finalize_border_war attacker = <id> / <variable>
The attacker state.

defender = <id> / <variable>
The defender state.
attacker_win = <bool>
Makes the attacker the winner.
defender_win = <bool>
Makes the defender the winner.

finalize_border_war = {
    attacker_win = yes
    attacker = 527
    defender = 408
}
Ends an on-going border war.   1.5

Country Scope

The effects here must be used within a country scope.

General

Name Parameters Examples Description Notes Version Added
set_country_flag <flag>
An unique string to identify the country flag with.
set_country_flag = my_flag Defines a country flag.   1.0
clr_country_flag <flag>
The unique string of a country flag to clear.
clr_country_flag = my_flag Clears a defined country flag.   1.0
modify_country_flag flag = <flag>
The country flag to modify.

value = <value>
The value to set it to: 0 or 1

modify_country_flag = {
    flag = my_flag
    value = 1
}
Modifies a country flag. Use variables instead. 1.3
country_event id = <event>
The event to fire.

days = <event> / <variable>
Fires the event in the specified number of days. Optional.
hours = <event> / <variable>
Fires the event in the specified number of hours. Optional.
random = <event>
Adds a random number (between 0 and random, inclusive) of hours to the scheduled fire time. Optional.

country_event = {
    id = my_event.1
    days = 10
    random = 50
}
Fires the specified event for the current country. Where triggers do not need to be repeatedly checked random can be a performance light alternative to mean_time_to_happen for scheduling events. 1.0
news_event id = <event>
The event to fire.

days = <event> / <variable>
Fires the event in the specified number of days. Optional.
hours = <event> / <variable>
Fires the event in the specified number of hours. Optional.
random = <event>
Adds a random number (between 0 and random, inclusive) of hours to the scheduled fire time. Optional.

news_event = {
    id = my_event.1
    days = 10
    random = 50
}
Fires the specified news event for the current country. The news event uses a different interface to the country event.

Where triggers do not need to be repeatedly checked random can be a performance light alternative to mean_time_to_happen for scheduling events.

1.0
set_cosmetic_tag <string>
The cosmetic tag to switch to.
set_cosmetic_tag = SAF_SOV_communism
Makes the current scope use the specified cosmetic tag, changing name and flag.   1.3
drop_cosmetic_tag <bool>
Boolean.
drop_cosmetic_tag = yes
Makes the current scope drop the current cosmetic tag they are using.   1.3
set_rule <rule>
Boolean.
set_rule = {
    can_create_factions = yes
}
Toggles the special game rules for the current scope. Possible rules:
  • can_be_called_to_war
  • can_boost_other_ideologies
  • 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_use_kamikaze_pilots
  • units_deployed_to_overlord (subjects only)
1.0

State

Name Parameters Examples Description Notes Version Added
add_state_core <scope> / <variable>
The state to add core to.
add_state_core = 345
Adds a core for the current scope to the specified state.   1.0
remove_state_core <scope> / <variable>
The state to remove core from.
remove_state_core = 345
Removes the core of the current scope from the specified state.   1.0
set_capital <scope> / <variable>
The state to make capital.
set_capital = 345
Makes the specified state the current scope's capital state.   1.0
add_state_claim <scope> / <variable>
The state to add a claim to.
add_state_claim = 345
Adds a claim for the current scope on the specified state.   1.0
remove_state_claim <scope> / <variable>
The state to remove the claim from.
remove_state_claim = 345
Removes a claim of the current scope from the specified state.   1.0
set_state_owner <scope> / <variable>
The state to change ownership of.
set_state_owner = 345
Makes the current scope the owner of the specified state.   1.0
set_state_controller <scope> / <variable>
The state to change controller of.
set_state_controller = 345
Makes the current scope the controller of the specified state.   1.0
transfer_state <scope> / <variable>
The state to change owner and controller of.
transfer_state = 345
Makes the current scope the owner and controller of the specified state.   1.0
set_province_controller <id>
The province to change controller of.
set_province_controller = 2999
Changes the controller of the specified province to the current scope.   1.0

Powers

Name Parameters Examples Description Notes Version Added
add_political_power <int> / <variable>
The amount to add.
add_political_power = 100
add_political_power = var:my_var
Adds the specified amount of political power to the current scope.   1.0
set_political_power <int> / <variable>
The amount to add.
add_political_power = 100
Sets the specified amount of political power for the current scope.   1.0
add_stability <int> / <variable>
The amount to add.
add_stability = 0.1
Adds to the current stability value for the current scope. Stability values are between 0 and 1. 1.5
set_stability <int> / <variable>
The amount to add.
set_stability = 0.5
Sets the current stability value for the current scope. Stability values are between 0 and 1. 1.5
add_war_support <int> / <variable>
The amount to add.
add_war_support = 0.1
Adds to the current war support value for the current scope. War Support values are between 0 and 1. 1.5
set_war_support <int> / <variable>
The amount to set.
set_war_support = 0.5
Sets the current war support value for the current scope. War Support values are between 0 and 1. 1.5
add_command_power <int> / <variable>
The amount to add.
add_command_power = 100
Adds the specified amount of command power to the current scope.   1.5

Politics

Name Parameters Examples Description Notes Version Added
kill_country_leader <bool>
Boolean.
kill_country_leader = yes
Kills the country leader for the current scope.   1.0
retire_country_leader <bool>
Boolean.
retire_country_leader = yes
Retires and removes the country leader as head of their party for the current scope.   1.0
set_country_leader_ideology <government>
The government to set.
set_country_leader_ideology = socialism
Changes the country leader's government type for the current scope.   1.0
add_country_leader_trait <trait>
The trait to add.
add_country_leader_trait = nationalist_symbol
Adds the specified trait to the current scope's country leader. Traits are found in Template:Path. 1.0
remove_country_leader_trait <trait>
The trait to remove.
remove_country_leader_trait = nationalist_symbol
Removes the specified trait from the current scope's country leader. Traits are found in Template:Path. 1.0
hold_election <scope>
The country to hold an election for.
hold_election = ROOT
Executes the events in the on_new_term_election on action for the current scope.   1.0
add_popularity ideology = <ideology>
The party to change.

popularity = <int> / <variable>
The amount of popularity to change.

add_popularity = {
    ideology = fascism
    popularity = -0.5
}
Adjusts the popularity for the specified party in the current scope. Values used are 0 to 1. 1.0
set_politics ruling_party = <ideology>
The party to set.

elections_allowed = <bool>
Whether elections are allowed. Optional.
last_election = <date>
When the last election was. Optional.
election_frequency = <int>
How often in months an election occurs. Optional.
Parties scope
popularity = <float>
The party popularity.
banned = <bool>
Whether this party is considered banned.

set_politics = {
    parties = {
		democratic = { 
			popularity = 0
		}

		fascism = {
			popularity = 0
		}
		
		communism = {
			popularity = 0
		}
		
		neutrality = { 
			popularity = 100
		}
	}
	
	ruling_party = neutrality
}
Sets the political party setup for the current scope.   1.0
set_political_party ideology = <ideology>
The party to change.

popularity = <int>
The amount of popularity to set.

set_political_party = {
    ideology = fascism
    popularity = 50
}
Sets the popularity for the specified political party in the current scope.   1.0
set_party_name ideology = <ideology>
The party to change.

long_name = <string>
The new full name for the party.
name = <string>
The new short name for the party.

set_party_name = { 
    ideology = neutrality 
    long_name = GER_neutrality_party_kaiserreich_long 
    name = GER_neutrality_party_kaiserreich 
}
Changes the name of the specified political party for the current scope.   1.0
create_country_leader name = <string>
The name of the leader.

desc = <string>
The description of the leader.
picture = <string>
The graphical reference to the leader portrait.
expire = <string>
When the leader dies in history.
ideology = <string>
The ideology government the leader belongs to.
Traits scope
<trait>
The trait to add. Can add multiple.

create_country_leader = {
	name = "Mohammed Zahir Shah"
	desc = "POLITICS_MOHAMMED_ZAHIR_SHAH_DESC"
	picture = "Portrait_Afghanistan_Mohammed_Zahir_Shah.dds"
	expire = "1965.1.1"
	ideology = despotism
	traits = {
		
	}
}
  The portrait string can include the full path (i.e. gfx/leaders/my_folder/custom_pic.dds) or just the name of the image (i.e. custom_pic.dds).

With just the name, the image must be in a folder that matches the tag of the current scope, for example Template:Path.

1.0

Diplomacy

Name Parameters Examples Description Notes Version Added
set_major <bool>
Boolean.
set_major = yes
Makes the current scope a major country.   1.0
create_faction <string>
The name of the faction.
create_faction = MY_FACTION_NAME
Creates a faction with the specified name for the current scope. The current scope and any subjects automatically join the faction.   1.0
add_to_faction <TAG>
The TAG of the nation to add to the faction of the current scope.
FACTION_LEADER_TAG = { add_to_faction = TAG_TO_ADD }
Adds the TAG_TO_ADD to the faction of the FACTION_LEADER_TAG.   1.0
leave_faction <bool>
Boolean.
leave_faction = yes
Removes the current scope from the faction they are part of.   1.5
remove_from_faction <string>
The name of the faction.
remove_from_faction = MY_FACTION_NAME
Removes the current scope from the specified faction.   1.0
dismantle_faction <bool>
Boolean.
dismantle_faction = yes
Dismantles the faction of the current scope.   1.0
puppet <scope>
The target country.
puppet = GER
Makes the specified country the puppet of the current scope.   1.0
end_puppet <scope>
The target country.
end_puppet = GER
Removes the puppet status between the target and the current scope.   1.0
release <scope>
The target country.
release = GER
Releases the specified subject or core-only country as a free nation.   1.0
release_puppet <scope>
The target country.
release_puppet = GER
Releases the specified subject or core-only country as a puppet for the current scope.   1.0
give_guarantee <scope>
The target country.
give_guarantee = GER
Makes the current scope guarantee the specified country.   1.0
give_military_access <scope>
The target country.
give_military_access = GER
Makes the specified country grant the current scope military access to their country.   1.0
recall_attache <scope>
The target country with an attache.
recall_attache = GER
Recalls the current scope's attache from the specified country.   1.5
diplomatic_relation country = <scope>
The target country to alter the relationship with ROOT.

relation = <type>
The relation to change.
active = <bool>
Whether the relation is started or broken.

diplomatic_relation = {
    country = SOV
    relation = guarantee
    active = no
}
Used to define a diplomatic relation between the current scope and target scope country. Possible relations:
  • non_aggression_pact
  • guarantee
  • puppet
  • military_access
1.0
add_opinion_modifier target = <scope>
The target country.

modifier = <modifier>
The opinion modifier to add.

add_opinion_modifier = {
    target = GER
    modifier = faction_traitor
}
Adds the specified opinion modifier for the current scope towards the specified scope. Opinion modifiers are found in Template:Path. 1.0
remove_opinion_modifier target = <scope>
The target country.

modifier = <modifier>
The opinion modifier to remove.

remove_opinion_modifier = {
    target = GER
    modifier = faction_traitor
}
Removes the specified opinion modifier for the current scope towards the specified scope. Opinion modifiers are found in Template:Path. 1.0
reverse_add_opinion_modifier target = <scope>
The target country.

modifier = <modifier>
The opinion modifier to add.

reverse_add_opinion_modifier = {
    target = GER
    modifier = faction_traitor
}
Adds the specified opinion modifier for the specified scope towards the current scope. Opinion modifiers are found in Template:Path. 1.0
add_relation_modifier target = <scope>
The target country.

modifier = <modifier>
The relation modifier to add.

add_relation_modifier = {
    target = SWE
    modifier = HUN_dynastic_ties_license
}
Adds the specified relation modifier for the current scope towards the specified scope. Relation modifiers are found in Template:Path. 1.4
remove_relation_modifier target = <scope>
The target country.

modifier = <modifier>
The relation modifier to remove.

remove_relation_modifier = {
    target = SWE
    modifier = HUN_dynastic_ties_license
}
Removes the specified relation modifier for the current scope towards the specified scope. Relation modifiers are found in Template:Path. 1.4

Subjects

Name Parameters Examples Description Notes Version Added
add_autonomy_ratio value = <float>
The freedom score to add.

localization = <string>
The localization key for the modifier.

add_autonomy_ratio = {
    value = 0.1
    localization = AST_adopt_westminster
}
Adds a freedom score ratio modifier to the current scope. Used in the subject. 1.3
add_autonomy_score value = <float>
The freedom score to add.

localization = <string>
The localization key for the modifier.

add_autonomy_ratio = {
    value = 10
    localization = EXAMPLE
}
Adds an exact freedom score modifier to the current scope. Used in the subject. 1.3
set_autonomy target = <scope> / <variable>
The subject country.

autonomy_state = <type>
The type of autonomy state to set.
freedom_level = <float>
The new freedom level value. Optional.

set_autonomy = {
    target = AST
    autonomy_state = autonomy_free
}
Sets the autonomy level for the specified country. The autonomy states are found in Template:Path. 1.3
release_autonomy target = <scope> / <variable>
The subject country.

autonomy_state = <type>
The type of autonomy state to set.
freedom_level = <float>
The new freedom level value. Optional.

release_autonomy = {
    target = VIN
    autonomy_state = autonomy_puppet
    freedom_level = 0.5
}
Releases the country and sets the autonomy level for the specified country. The autonomy states are found in Template:Path. 1.3

War

Name Parameters Examples Description Notes Version Added
add_threat <int>
The amount to change by.
add_threat = 10
Adjusts the level of World Tension.   1.0
add_named_threat threat = <int>
The amount to change by.

name = <string>
The localization string.

add_named_threat = { 
    threat = 5 
    name = GER_rhineland
}
Adjusts the level of World Tension and adds an entry in the World Tension tooltip.   1.0
annex_country target = <scope>
Which country to annex.

transfer_troops = yes
Whether to transfer the troops of the annexed country.

annex_country = {
    target = GER
    transfer_troops = yes
}
Annex the specified country for the current scope.   1.0
add_to_war targeted_alliance = <scope>
The country to assist.

enemy = <scope>
The country attacking the ally.
hostility_reason = <string>
Localization for the reason for joining. Optional.

add_to_war = { 
    targeted_alliance = PREV 
    enemy = HUN 
    hostility_reason = asked_to_join
}
Adds the current scope into the war of their ally against the specified enemy.   1.0
declare_war_on target = <scope> / <variable>
The country to attack.

type = <wargoal>
The wargoal to declare with.

declare_war_on = {
    target = GER
    type = annex_everything
}
Makes the current scope declare war on the specified country with the specified wargoal. Wargoals are found in Template:Path. 1.0
white_peace <scope> / <variable>
The scope to white peace.

<message>
The reason for peace.

white_peace = GER
white_peace = {
    tag = GER
    message = EXAMPLE
}
Makes the current scope white peace the specified scope.   1.0
set_truce target = <scope>
The scope to truce with.

days = <int>
The duration of the truce.

set_truce = {
    target = GER
    days = 90
}
Makes the current scope truce with the specified scope.   1.0
create_wargoal target = <scope> / <variable>
The country to target.

type = <wargoal>
The wargoal to generate.
generator = { <state id> }
The states to supply the wargoal (i.e. take_state_focus).

create_wargoal = {
    type = puppet_wargoal_focus
    target = ROOT
}
Grants the current scope a wargoal against the specified country.   1.0
start_civil_war ideology = <ideology>
The ideology of the breakaway country.

ruling_party = <ideology>
The ruling party of the original country. Optional.
size = <float>
The size of the breakaway country and the fraction of the original stockpile and military units it will receive. Optional.
capital = <state>
The capital of the breakaway country. Optional.
only_own_territory = <bool>
Limits the breakaway country to only own territory. Optional.
states = { <state> }
The states included in the breakway country. Optional.
states_filter = { <triggers> }
Filters to apply to the state assignment for the breakaway country. Optional.
keep_unit_leaders = { <unit leader id> }
Keep the specified leaders. Optional.
keep_unit_leaders_trigger = { <triggers>
Keep the specified leaders that meet the triggers. Optional.

start_civil_war = {
    ruling_party = communism
    ideology = ROOT
    size = 0.8
    only_own_territory = no
    capital = 282
    states = { 
        282 533 536 555 529 530 528 
    }
    keep_unit_leaders = {
        750 751 752
    }
}
Starts a civil war for the current scope with the specified parameters.   1.0

Resources

Name Parameters Examples Description Notes Version Added
add_resource type = <resource>
The resource to add.

amount = <int>
The amount of resource to add.
state = <id>Which state to add the resource to.

add_resource = {
    type = oil
    amount = 50
    state = 88
}
Adds the specified resource in the specified amount to the specified state.   1.0
create_import resource = <resource>
The resource to import.

amount = <int>
The amount of resource to import.
exporter = <id>Which country exports the resource.

create_import = {
    resource = steel
    amount = 100
    exporter = GER
}
Creates an import for the current scope with the specified resource and from the specified exporter.   1.0

Buildings

Name Parameters Examples Description Notes Version Added
add_offsite_building type = <building>
The building to add.

level = <level> / <variable>
The maximum level to add.

add_offsite_building = { type = arms_factory level = 1 }
Adds an off-map building for the current scope that produces its effects without being present in a state.   1.5
modify_building_resources building = <building>
The building to modify.

resource = <resource>
The resource to add.
amount = <amount>
The amount of resource to add.

modify_building_resources = {
    building = synthetic_refinery
    resource = oil
    amount = 1
}
Modifies the resource output of the specified building for the current scope.   1.5

National Focus

Name Parameters Examples Description Notes Version Added
load_focus_tree <string>
The focus tree to load.
load_focus_tree = china_communist_focus
Loads a new focus tree for the current scope, retaining any shared focuses.   1.5
unlock_national_focus <focus>
The focus to unlock.
unlock_national_focus = my_focus
Unlocks the specified focus for the current scope.   1.0
complete_national_focus <focus>
The focus to complete.
complete_national_focus = my_focus
Completes the specified focus for the current scope.   1.0

Decisions

Name Parameters Examples Description Notes Version Added
activate_decision <decision>
The decision to activate.
activate_decision = my_decision
Activates the specified decision for the current scope, ignoring triggers for the decision. Decisions are found in Template:Path 1.0
activate_targeted_decision target = <scope>
The country to target.

decision = <decision>
The decision to activate.

activate_targeted_decision = {
    target = GER
    decision = my_decision
}
Activates the specified targeted decision for the specified target for the current scope. Decisions are found in Template:Path 1.5
remove_targeted_decision <decision>
The decision to remove.
remove_targeted_decision = {
    target = FROM
    decision = my_decision
}
Removes the specified targeted decision for the current scope. Decisions are found in Template:Path 1.5
unlock_decision_tooltip <decision>
The decision to display.
unlock_decision_tooltip = my_decision
Displays a special tooltip for the specified decision in the effect tooltip. Decisions are found in Template:Path 1.5
unlock_decision_category_tooltip <category>
The decision category to display.
unlock_decision_category_tooltip = my_category
Displays a special tooltip for the specified decision category in the effect tooltip. Decision categories are found in Template:Path 1.5

Missions

Name Parameters Examples Description Notes Version Added
activate_mission <mission>
The mission to activate.
activate_mission = my_mission
Activates the specified mission for the current scope, ignoring any triggers for the decision. Missions are found in Template:Path 1.5
activate_mission_tooltip <mission>
The mission to display.
activate_mission_tooltip = my_mission
Displays a special tooltip for the specified mission in the effect tooltip. Missions are found in Template:Path 1.5
remove_mission <mission>
The mission to remove.
remove_mission = my_mission
Removes the specified mission for the current scope. Missions are found in Template:Path 1.5

Technology

Name Parameters Examples Description Notes Version Added
add_research_slot <int>
The number of slots to add or remove.
add_research_slot = 1
Adjusts the number of research slots the current scope has. Can remove slots.   1.0
set_research_slots <int>
The number of slots to set.
set_research_slots = 4
Sets the number of research slots the current scope has.   1.0
add_tech_bonus bonus = <float>
The bonus to technology given.

uses = <int>
The amount of times the bonus can be used.
ahead_reduction = <float>
The cost reduction if ahead of time.
category = <string>
Which technology category the bonus applies to. Multiple can be defined.
technology = <string>
Which technology the bonus applies to. Multiple can be defined.

add_tech_bonus = {
    bonus = 0.5
    uses = 1
    category = radar_tech
}
Grants a research bonus to the current scope with the specified parameters.   1.0
set_technology <technology> = <int>
The technology to add.
set_technology = {
    suicide_craft = 1
}
Grants the specified technology to the current scope. A value of 1 sets the technology. A value of 0 removes the technology, but if it is a researchable technology, the duration to research isn't reset, meaning it can be researched in 1 day. 1.0
add_to_tech_sharing_group <string>
The group to add the current scope to.
add_to_tech_sharing_group = us_research
Adds the current scope to the specified technology sharing group.   1.3
remove_from_tech_sharing_group <string>
The group to remove the current scope from.
remove_from_tech_sharing_group = us_research
Removes the current scope from the specified technology sharing group.   1.3
modify_tech_sharing_bonus id = <string>
The group to modify.

bonus = <float>
The new bonus.

modify_tech_sharing_bonus = {
    id = us_research
    bonus = 0.5
}
Modifies the specified technology sharing group.   1.3

Ideas

Name Parameters Examples Description Notes Version Added
add_ideas <idea>
The idea to add.
add_ideas = my_idea
add_ideas = {
    my_idea_1
    my_idea_2
}
Adds the specified ideas to the current scope. Can be used as a scope to add multiple at once. 1.0
add_timed_idea idea = <idea>
The idea to add.

days = <int> / <variable>
The number of days to add the idea for.

add_timed_idea = {
    idea = my_idea
    days = 180
}
Adds the specified ideas to the current scope for the specified number of days.   1.0
modify_timed_idea idea = <idea>
The idea to modify.

days = <int> / <variable>
The number of days to add to the idea.

modify_timed_idea = {
    idea = my_idea
    days = 60
}
Extends the duration of the timed idea by the specified amount.   1.0
swap_ideas add_idea = <idea>
The idea to add.

remove_idea = <idea>
The idea to remove.

swap_ideas = {
    remove_idea = my_idea_1
    add_idea = my_idea_2
}
Switches two ideas with a tooltip displaying any modifier differences between them.   1.3
remove_ideas <idea>
The idea to remove.
remove_ideas = my_idea
remove_ideas = {
    my_idea_1
    my_idea_2
}
Removes the specified idea from the current scope. Can be used as a scope to remove multiple at once. 1.0
remove_ideas_with_trait <trait>
The trait to target.
remove_ideas_with_trait = motorized_equipment_manufacturer
Removes all ideas for the current scope that use the specified trait.   1.0
show_ideas_tooltip <idea>
The idea to display.
show_ideas_tooltip = my_idea
Displays the specified idea in the tooltip for the current effect scope. Does not add the idea.   1.0

Unit

Name Parameters Examples Description Notes Version Added
load_oob <oob>
The OOB to load.
load_oob = "GER_default"
Loads the specified OOB for the current scope, applying the effects within.   1.0
division_template name
The name of the division.
regiments = {
    <unit> = { x = 0 y = 0 }
}
support = {
    <unit> = { x = 0 y = 0 }
}

The composition of the division.

division_template = {
    name = "Test"
    regiments = {
        infantry = { x = 0 y = 0 }
        infantry = { x = 0 y = 1 }
        infantry = { x = 0 y = 2 }
        infantry = { x = 0 y = 3 }
    }
    support = { 
        military_police = { x = 0 y = 0 }
    } 
}
Creates and adds the specified division template to the current scope. The x and y attributes represent the rows and columns in the division designer. 1.0
set_division_template_lock division_template = <string>
The name of the division template.

is_locked = <bool>
Whether the division is locked or not.

set_division_template_lock = {
    division_template = "Infantry Division"
    is_locked = yes
}
Toggles the locked status on a division template for the current scope, which prevents editing or deletion.   1.5
delete_unit_template_and_units division_template = <string>
The name of the division template.
delete_unit_template_and_units = {
    division_template = "Infantry Division"
}
Deletes the specified division template and all units using it for the current scope.   1.5

Equipment

Name Parameters Examples Description Notes Version Added
set_equipment_fraction <float> / <variable>
The fraction of equipment to remove.
set_equipment_fraction = 0.5
Reduces the overall equipment stockpile by the specified fraction. This should not be used in civil wars to simulate stockpile splitting. start_civil_war now automatically divides stockpiles according to the respective size. 1.0
add_equipment_to_stockpile type = <equipment>
The equipment to add. Can be archetype.

amount = <int>
The amount to add.
producer = <scope>
Defines who produced the equipment. Optional.

add_equipment_to_stockpile = {
    type = infantry_equipment
    amount = 100
    producer = GER
}
Adds the specified equipment to the current scope. Note that removal will only remove equipment with the same producer defined in the effect. 1.0
send_equipment type = <equipment>
The equipment to add. Can be archetype.

amount = <int> / <variable>
The amount to add.
target = <scope> / <variable>
Which country receives the equipment.

send_equipment = {
    equipment = infantry_equipment
    amount = 100
    target = GER
}
Sends the specified amount of equipment to the specified target, removing said equipment from the current scope.   1.0
create_production_license target = <scope>
Which country receives the license.

cost_factor = <float>
Modifies the production cost.
Equipment scope
type = <equipment>
The equipment the country is licensed to produce. Must be an non-archetype equipment.

create_production_license = {
    target = HUN
    equipment = {
        type = fighter_equipment_1
    }
    cost_factor = 0
}
Grants the specified country a licensed to produce the specified equipment from the current scope.   1.4
create_equipment_variant name = <string>
The name of the variant

type = <equipment>
The equipment the variant is of.
parent_version = <int>
Ordering for multiple variants.
Upgrade scope
<upgrade> = <amount>
The upgrades configuration for the variant.

create_equipment_variant = { 
    name = "Montecuccoli Class" 
    type = light_cruiser_1 
    upgrades = { 
        ship_reliability_upgrade = 3 
        ship_engine_upgrade = 3 
        ship_gun_upgrade = 3 
        ship_anti_air_upgrade = 3 
    }
}
Creates the specified equipment variant for the current scope.   1.0
add_equipment_production amount = <int>
The amount to produce. Optional.

requested_factories = <int>
The number of factories to assigned initially. Optional.
progress = <float>
The initial production progress. Optional.
efficiency = <float>
The initial production efficiency. Optional.
Equipment scope
type = <equipment>
The name of the equipment to produce.
creator = <scope>
The country which is producing the equipment. Used if root scope isn't producer. Optional.
version_name = <string>The name of the variant to produce. Optional.

add_equipment_production = {
    equipment = {
        type = light_cruiser_2
    }
    requested_factories = 1
    progress = 0.95
    amount = 1
}
Starts a production line for the specified equipment for the current scope.   1.0

Army

Name Parameters Examples Description Notes Version Added
add_manpower <int> / <variable>
The amount to add.
add_manpower = 100000
add_manpower = var:my_var
Adds the specified amount of manpower to the current scope.   1.0
army_experience <float> / <variable>
The amount to add.
army_experience = 10
Adds the specified amount of army experience to the current scope.   1.0
create_corps_commander name = <string>
The name of the leader.

picture = <string>
The graphical reference of the picture of the leader.
skill = <int>
The skill of the leader.
attack_skill = <int>
The attack skill of the leader.
defense_skill = <int>
The defense skill of the leader.
planning_skill = <int>
The planning skill of the leader.
logistics_skill = <int>
The logistics skill of the leader.
traits = { <trait> }
The traits the leader spawns with.
female = <bool>
The gender of the leader.

create_corps_commander = {
	name = "Jean de Lattre de Tassigny"
	picture = "Portrait_France_Jean_de_Lattre_de_Tassigny.dds"
	traits = { trickster brilliant_strategist }
	skill = 4
	attack_skill = 4
	defense_skill = 2
	planning_skill = 4
	logistics_skill = 3
}
Creates a commander for the current scope with the specified attributes. Traits are found in Template:Path. 1.0
create_field_marshal name = <string>
The name of the leader.

picture = <string>
The graphical reference of the picture of the leader.
skill = <int>
The skill of the leader.
attack_skill = <int>
The attack skill of the leader.
defense_skill = <int>
The defense skill of the leader.
planning_skill = <int>
The planning skill of the leader.
logistics_skill = <int>
The logistics skill of the leader.
traits = { <trait> }
The traits the leader spawns with.

create_field_marshal = {
	name = "Maurice Gamelin"
	picture = "Portrait_France_Maurice_Gamelin.dds"
	traits = { defensive_doctrine }
	skill = 2
	attack_skill = 1
	defense_skill = 3
	planning_skill = 2
	logistics_skill = 1
}
Creates a field marshal for the current scope with the specified attributes. Traits are found in Template:Path. 1.0

Navy

Name Parameters Examples Description Notes Version Added
navy_experience <float> / <variable>
The amount to add.
navy_experience = 10
Adds the specified amount of navy experience to the current scope.   1.0
destroy_ships type = <ship>
The type of ship to destroy.

count = <int> or all
The amount to destroy.

destroy_ships = {
    type = destroyer
    count = all
}
Destroys the specified type and amount of ships controlled by the current scope.   1.5
transfer_navy target = <scope>
The target country.
transfer_navy = {
    target = GER
}
Transfers the current scope navy to the specified country.   1.5
transfer_ship type = <ship>
The type of ship to transfer.<br target = <scope>
The target country.

<code>prefer_name = <string>
The new name for the ships in the target country. Optional.

transfer_ship = {
    prefer_name = "HMS Achilles"
    type = light_cruiser
    target = NZL
}
Transfers the specified type of ship from the current scope to the specified country.   1.4
create_navy_leader name = <string>
The name of the leader.

picture = <string>
The graphical reference of the picture of the leader.
skill = <int>
The skill of the leader.
traits = { <trait> }
The traits the leader spawns with.

create_navy_leader = {
	name = "François Darlan"
    picture = "Portrait_France_Francois_Darlan.dds"
	traits = { superior_tactician }
	skill = 3
}
Creates a naval leader for the current scope with the specified attributes. Traits are found in Template:Path. 1.0

Air

Name Parameters Examples Description Notes Version Added
air_experience <float> / <variable>
The amount to add.
air_experience = 10
Adds the specified amount of air experience to the current scope.   1.0
add_ace name = <string>
The name of the ace.

surname = <string>
The surname of the ace.
callsign = <string>
The callsign of the ace.
type = <type>
The ace type.
is_female = <bool>
The gender of the ace.

add_ace = {
    name = "Amelia"
    surname = "Earhart"
    callsign = "Revenant"
    type = fighter_genius
    is_female = yes
}
Adds an ace for the current scope. Ace types found in Template:Path. 1.0

AI

Name Parameters Examples Description Notes Version Added
add_ai_strategy type = <type>
The type of strategy.

id = <scope>
What country the strategy is against.
value = <int>
The weighting added by the strategy.

add_ai_strategy = {
    type = alliance
    id = GER
    value = 200
}
Sets an AI strategy for the current scope. See AI Modding for more details. 1.0

State Scope

The effects here must be used within a state scope.

General

Name Parameters Examples Description Notes Version Added
state_event id = <event>
The event to fire.

days = <event> / <variable>
Fires the event in the specified number of days. Optional.
hours = <event> / <variable>
Fires the event in the specified number of hours. Optional.
random = <event>
Adds a random number (between 0 and random, inclusive) of hours to the scheduled fire time. Optional.
trigger_for = <scope>
Fires event in the specified scope.

state_event = {
    id = my_event.1
    days = 10
    random = 50
    trigger_for = controller
}
Fires the specified event for the current state. Where triggers do not need to be repeatedly checked random can be a performance light alternative to mean_time_to_happen for scheduling events. 1.0
set_state_flag <flag>
An unique string to identify the state flag with.
set_state_flag = my_flag Defines a state flag.   1.0
clr_state_flag <flag>
The unique string of a state flag to clear.
clr_state_flag = my_flag Clears a defined state flag.   1.0
modify_state_flag flag = <flag>
The state flag to modify.

value = <value>
The value to set it to: 0 or 1

modify_state_flag = {
    flag = my_flag
    value = 1
}
Modifies a state flag. Use variables instead. 1.3
set_state_name <string>
Defines the new name.
set_state_name = "Funland"
Changes the current state's name to the specified name.   1.3
reset_state_name <bool>
Boolean.
reset_state_name = yes
Resets any changes to the current state's name.   1.3
add_claim_by <scope> / <variable>
The country to add the claim for.
add_claim_by = SOV
Adds a claim for the specified country on the current scope.   1.0
remove_claim_by <scope> / <variable>
The country to remove the claim for.
remove_claim_by = SOV
Removes a claim by the specified country on the current scope.   1.0
add_core_of <scope> / <variable>
The country to add the core for.
add_core_of = SOV
Adds a core for the specified country on the current scope.   1.0
remove_core_of <scope> / <variable>
The country to remove the core for.
remove_core_of = SOV
Removes a core for the specified country on the current scope.   1.0
set_demilitarized_zone <bool>
Boolean.
set_demilitarized_zone = yes
Makes the current scope a demilitarized zone.   1.0
set_state_category <category>
The category to change to.
set_state_category = rural
Changes the current state category to the specified category. Categories are found in Template:Path 1.3
add_state_modifier Modifier scope

<modifier> = <float>
Adds a modifier to the state.

add_state_modifier = {
    modifier = {
        local_resources = 2.0
    }
}
Adds a modifier to the current state.   1.3
add_manpower <int> / <variable>
The amount to add.
add_manpower = 10000
Adds the specified amount of manpower to the current state.   1.0
add_resource type = <resource>
The resource to add.

amount = <int>
The amount to add.

add_resource = {
    type = oil
    amount = 100
}
Adds the specified resource in the specified amount to the current state.   1.0
set_border_war <bool>
Boolean.
set_border_war = yes
Enables Border War status for the current state.   1.0
create_unit division = <division string>
The division string.

owner = <scope>
The owner of the division.
prioritize_location = <province>
Prioritize the specified province in the state.

create_unit = {
    division = "name = \"Infantry Division\" division_template = \"Infantry Division\" start_experience_factor = 0.5 start_equipment_factor = 0.5"
    owner = GER
}
Adds the specified division to the current state. The division string must be formatted as it is seen in the examples. 1.3

Buildings

Name Parameters Examples Description Notes Version Added
add_building_construction type = <string>
The building to add.

level = <int> / <variable>
The level to set the building to.
instant_build = <bool>
Defines whether the buildings are instantly built.
province = <id>
Defines the exact province to add provincal buildings in. Can be used as a scope.
Province scope
all_provinces = <bool>
Affect all provinces. Used in the province scope.
limit_to_coastal = <bool>
Affect coastal provinces. Used in the province scope.
limit_to_naval_base = <bool>
Affect naval base provinces. Used in the province scope.
limit_to_border = <bool>
Affect border provinces. Used in the province scope.
level = <int>
Affect only provinces with buildings level below, at or above the specified level. Used in the province scope.
id = <id>
Affect the specified province. Used in the province scope.

add_building_construction = {
    type = arms_factory
    level = 5
    instant_build = yes
}
add_building_construction = {
    type = bunker
    level = 10
    instant_build = yes
    province = {
        all_provinces = yes
        limit_to_border = yes
    }
}
add_building_construction = {
    type = bunker
    level = 1
    instant_build = yes
    province = 2999
}
Starts construction in the current state for the specified building.   1.0
set_building_level type = <string>
The building to add.

level = <int> / <variable>
The level to set the building to.
instant_build = <bool>
Defines whether the buildings are instantly built.
province = <id>
Defines the exact province to add provincal buildings in. Can be used as a scope.
Province scope
all_provinces = <bool>
Affect all provinces. Used in the province scope.
limit_to_coastal = <bool>
Affect coastal provinces. Used in the province scope.
limit_to_naval_base = <bool>
Affect naval base provinces. Used in the province scope.
limit_to_border = <bool>
Affect border provinces. Used in the province scope.
level = <int>
Affect only provinces with buildings level below, at or above the specified level. Used in the province scope.
id = <id>
Affect the specified province. Used in the province scope.

set_building_level = {
    type = infrastructure
    level = 10
    instant_build = yes
}
set_building_level = {
    type = bunker
    level = 3
    province = {
        all_provinces = yes
        limit_to_border = yes
        level < 3
    }
}
Sets the specified building to the current state (or provinces within the state). The province scope is used for provincal level buildings. 1.4
damage_building type = <building>
The building to damage.

damage = <float>
The amount of damage to inflict.
province = <id>
The province to target for provincal buildings.

damage_building = {
    type = infrastructure
    damage = 1
}
Damages the specified building in the current state. The health of buildings is determined by the value attribute in a building's definition. This is multiplied by their level to get their total health. 1.3
remove_building type = <building>
The building to remove.

level = <int> / <variable>
The levels to remove.

remove_building = {
    type = arms_factory
    level = 5
}
Removes the specified building in the current state. For shared buildings level determines the amount, whereas for the others it is the actual level.   1.0
add_extra_state_shared_building_slots <int> / <variable>
The amount of slots to add or remove.
add_extra_state_shared_building_slots = 2
Adjusts the number of shared building slots for the current state.   1.0

Unit Leader Scope

The effects here must be used within a unit leader scope.

General

Name Parameters Examples Description Notes Version Added
unit_leader_event id = <event>
The event to fire.

days = <event> / <variable>
Fires the event in the specified number of days. Optional.
hours = <event> / <variable>
Fires the event in the specified number of hours. Optional.
random = <event>
Adds a random number (between 0 and random, inclusive) of hours to the scheduled fire time. Optional.

unit_leader_event = {
    id = my_event.1
    days = 10
    random = 50
}
Fires the specified event for the owner of the current unit leader. Uses a special interface displaying the current unit leader portrait.

Where triggers do not need to be repeatedly checked random can be a performance light alternative to mean_time_to_happen for scheduling events.

1.5
set_unit_leader_flag <flag>
An unique string to identify the unit leader flag with.
set_unit_leader_flag = my_flag Defines a unit leader flag.   1.5
clr_unit_leader_flag <flag>
The unique string of a unit leader flag to clear.
clr_unit_leader_flag = my_flag Clears a defined unit leader flag.   1.5
modify_unit_leader_flag flag = <flag>
The unit leader flag to modify.

value = <value>
The value to set it to: 0 or 1

modify_unit_leader_flag = {
    flag = my_flag
    value = 1
}
Modifies a unit leader flag.   1.5
promote_leader <bool>
Boolean
promote_leader = yes
Promotes the current unit leader to Field Marshal (if Commander.   1.5
demote_leader <bool>
Boolean
demote_leader = yes
Demotes the current unit leader to Commander (if Field Marshal).   1.5
retire <bool>
Boolean>
retire = yes
Retires the current unit leader (removing them).   1.5
remove_unit_leader <id>
The id of the unit leader.
remove_unit_leader = 70
Removes the specified unit leader by their id.   1.0
set_nationality <scope> / <variable>
The target country.
set_nationality = GER
Switches the current unit leader to the specified country, giving them the leader.   1.5
add_unit_leader_trait <trait>
The trait to add.
add_unit_leader_trait = old_guard
Adds the specified trait to the current unit leader. Traits are found in Template:Path. 1.0
remove_unit_leader_trait <trait>
The trait to remove.
remove_unit_leader_trait = old_guard
Removes the specified trait from the current unit leader. Traits are found in Template:Path. 1.0
add_timed_unit_leader_trait <trait>
The trait to add.

days = <int>
The duration of the trait.

add_timed_unit_leader_trait = {
    trait = wounded
    days = 90
}
Adds the specified trait to the current unit leader for the specified duration. Traits are found in Template:Path. 1.5
replace_unit_leader_trait       Traits are found in Template:Path. 1.5

Combat

Name Parameters Examples Description Notes Version Added
supply_units <int> / <variable>
The amount of hours of supply.
supply_units = 24
Adds the specified amount of hours of supply to troops led by the current unit leader.   1.5
add_max_trait <int>
The amount to add.
add_max_trait = 1
Adds the specified amount of assignable trait slots to the current unit leader.   1.5
add_skill_level <int>
The skill to add.
add_skill_level = 1
Adds skill to the current unit leader.   1.5
add_logistics <int>
The skill to add.
add_logistics = 1
Adds logistics skill to the current unit leader.   1.5
add_planning <int>
The skill to add.
add_planning = 1
Adds planning skill to the current unit leader.   1.5
add_defense <int>
The skill to add.
add_defense = 1
Adds defense skill to the current unit leader.   1.5
add_attack <int>
The skill to add.
add_attack = 1
Adds attack skill to the current unit leader.   1.5
add_temporary_buff_to_units combat_offense = <float>
The bonus to grant. Optional.

combat_breakthrough = <float>
The bonus to grant. Optional.
combat_defense = <float>
The bonus to grant. Optional.
combat_entrenchment = <float>
The bonus to grant. Optional.
org_damage_multiplier = <float>
The bonus to grant. Optional.
str_damage_multiplier = <float>
The bonus to grant. Optional.
war_support_reduction_on_damage = <float>
The bonus to grant. Optional.
cannot_retreat_while_attacking = <float>
The bonus to grant. Optional.
cannot_retreat_while_defending = <float>
The bonus to grant. Optional.
days = <int>
The duration of the buff. Optional.
tooltip = <string>
The tooltip to display for the buff.

add_temporary_buff_to_units = {
    combat_offense = 0.25
    combat_breakthrough = 0.25
    org_damage_multiplier = -1.0
    str_damage_multiplier = 0.25
    war_support_reduction_on_damage = 0.2
    cannot_retreat_while_attacking = 1.0
				
    days = 7
    tooltip = ABILITY_FORCE_ATTACK_TOOLTIP
}
Adds the specified combat buff to the current unit leader.   1.5
boost_planning <float>
The amount to add.
boost_planning = 1
Improves the planning of units controlled by the current unit leader.   1.5

Flow Control

These scopes are used within effect scopes to control the execution of effects.

If, Else If and Else

These scopes allow effects to be conditionalized, so they only occur when the requisite triggers are met.

For example, if you only have an effect to occur for Germany, you'd do the following:

if = {
    limit = {
        original_tag = GER
    }   
    add_stability = 0.1
}

If you then wanted England to have a similar effect, and everyone else to have something else, you do the following:

if = {
    limit = {
        original_tag = GER
    }   
    add_stability = 0.1
}
else_if = {
    limit = {
        original_tag = ENG
    }
    add_stability = 0.25
}
else = {
    add_stability = 0.05
}

As you can see, this allows for flexibility in how effects occur and cuts down on duplication.

Hidden Effect

This scope hides the presence of the effects within it in the player's tooltip. This is used to execute effects without the player seeing them. For example, you may want to manipulate some variables in an event. Showing them to the player may confuse them, so it is best to hide the effects within an hidden effect scope, like so:

hidden_effect = {
    set_variable = { my_var = 100 }
}

Random List

This scope allows the creation of a random selection of effects. For example, if you wanted an effect to randomly given the player one out of four bonuses, you'd do the following:

random_list = {
    25 = {
        add_stability = 0.5
    }
    25 = {
        add_manpower = 10000
    }
    25 = {
        add_war_support = 0.5
    }
    25 = {
        army_experience = 100
    }
}

Note that if you want to create a repeatable decision including a random list, by default the same decision will pick the same random result every time it is triggered in a game. You can reverse this behaviour by including the following line in the decision block:

fixed_random_seed = no

Effect Tooltip

This scope will display the tooltip information of the effects within, without actually executing the effects. This is useful when you want to show what the effect may look like to the player. Here is an example:

effect_tooltip = {
    every_owned_state = {
        add_manpower = 10000
    }
}
HOI4 Mechanics
Opinion ModifiersModifiersEffectsTriggers