编辑“Variables”（章节）

== Commands ==

=== Setting variables ===

You can make a variable out of various numbers. The easiest is <code>set_variable</code> and <code>change_variable</code>:
* <code>set_variable = { which = star_temperature value = @G2V_star_temperature }</code> – Sets a specific star's temperature to the scripted variable value
But you can also do it with:
* <code>get_galaxy_setup_value</code>: galaxy setup options
* <code>export_trigger_value_to_variable</code>: the value of a trigger (e.g. number of pops in the empire). Should work for all triggers that are comparing a single numerical value or (since 3.3) the value of count_x triggers. Otherwise for triggers with { }, you can specify parameters = { }
* <code>export_modifier_to_variable</code>: the sum of the specific modifier applying to this scope, e.g. the amount of pop_citizen_happiness that a pop is gaining from all sources (including any country and planet modifiers).
* <code>export_resource_income_to_variable</code>, <code>export_resource_stockpile_to_variable</code>: country's monthly income or current stockpile of a resource
''For more [[#Limitations and other notes|see below]].''

=== Manipulating variables ===

Once the variable is set, you can then alter it with standard mathematical operations:
* <code>change_variable = { which = <string> value = <float>/<variable>/<scope.variable>/trigger:<trigger> }</code> – Increments a previously-set variable by a specific amount
* <code>subtract_variable = { which = <string> value = <float>/<variable>/<scope.variable>/trigger:<trigger> }</code> – Decrements a previously-set variable by a specific amount
* <code>multiply_variable = { which = <string> value = <float>/<variable>/<scope.variable>/trigger:<trigger> }</code> – Multiplies a previously-set variable by a specific amount
* <code>divide_variable = { which = <string> value = <float>/<variable>/<scope.variable>/trigger:<trigger> }</code> – Divides a previously-set variable by a specific amount
* <code>modulo_variable = { which = <string> value = <float>/<variable>/<scope.variable>/trigger:<trigger> }</code> – Modulos a previously-set variable by a specific amount i.e. X % Y

In all of these effects (except round/floor/ceiling variables), you can add/multiply/whatever the variable by another one, with dot scoping and referring to triggers allowed.<sup>''with 3.1''</sup> E.g.:
 multiply_variable = {
 	which = my_var <i class=effect-green># must be directly referring to a variable</i>
 	value = fromfromfrom.owner.trigger:num_pops
 }

Once you are done with a variable, you can clear it using: <code>clear_variable = <string></code><sup>(''since 3.0'')</sup>

Also worth noting: if you need to manipulate a variable in a trigger, you can use the <code>check_variable_arithmetic</code> trigger (which now supports an unlimited number of <code>add/subtract/divide/multiply/modulo operations</code>).<sup>''with 3.1''</sup>

=== Checking variable values ===

* <code>check_variable = { which = <variable> value = <float>/<variable>/<scope.variable>/trigger:<trigger>/modifier:<modifier> }</code>
This checks a variable for the chosen scope – accepts <code>=</code>, <code>>=</code>, <code>></code>, <code><=</code>, and <code><</code> as operators.
: When you are using the value of a variable, you can now (''with 3.1'') use dot scoping: <code>value = owner.capital_scope.my_var</code>
: You can also directly refer to the value of a trigger: <code>value = trigger:num_pops</code>
: A combination of the two is also possible: <code>value = owner.capital_scope.trigger:num_pops</code>
: You can also (with 3.3) directly refer to the value of a modifier: <code>value = modifier:pop_growth_speed_reduction</code>
: This works almost everywhere where you are using variables. The exception is in the basic variable effects and triggers where you are specifying which variable to check or change.

 check_variable_arithmetic = {
 	which = <variable>
 	add/subtract/multiply/divide/modulo = <float>/<variable>/<scope.variable>/trigger:<trigger> <i class=effect-green># (note: this line can be repeated as many times as desired)</i>
 	value <=> <float>/<variable>/<scope.variable>/trigger:<trigger> <i class=effect-green># (the value to compare against)</i>
 }
This checks a variable for the scope if a certain amount of arithmetic is done to it (Note: the variable's value is not changed by this trigger).<sup>''with 3.0''</sup>

=== Copying variables between scopes ===

Just like with checking variables, you must (now ''with 3.1'') use dot scoping:
:<code>set_variable = { which = var1 value = owner.capital_scope.my_var }</code>


{{Spoiler|Header=<small>Pre 3.1 outdated syntax</small>|Text=* A '''scope''' (in the form of root/from/prev) ''which'' contains a variable with the ''same name'': <code><nowiki>(set|change|subtract|multiply|divide|modulo)_variable = { which = <variable_name> value = <scope> }</nowiki></code><br>* A '''scope reference''' to point to ''another'' variable in ''another'' scope <code>value = { scope = <scope> variable >=< <variable> }</code> <sup>(''with 3.0'')</sup>
We can copy variables direct between scopes. To do this, you can either name a scope to copy a variable of the same name, or specify both the scope and variable name. This command looks for a variable in the "owner" scope called "var1", and if it finds it, copies its value to "var1" in the current scope: <code>set_variable = { which = var1 value = owner }</code>
And this looks for a variable in the owner ''scope'' called "var2", to set the value of "var1": <sup>(''with 3.0'')</sup> <code>set_variable = { which = var1 value = { scope = owner variable = var2 } }</code>}}