Enum Effect

pub enum Effect {
    Yes,
    Boolean,
    Integer,
    ScriptValue,
    NonNegativeValue,
    Date,
    Scope(Scopes),
    ScopeOkThis(Scopes),
    Item(Item),
    ScopeOrItem(Scopes, Item),
    Target(&'static str, Scopes),
    TargetValue(&'static str, Scopes, &'static str),
    ItemTarget(&'static str, Item, &'static str, Scopes),
    ItemValue(&'static str, Item),
    Desc,
    Timespan,
    Control,
    ControlOrLabel,
    Unchecked,
    UncheckedTodo,
    Choice(&'static [&'static str]),
    Removed(&'static str, &'static str),
    Vb(fn(_: &Token, _: &Block, _: &Everything, _: &mut ScopeContext, _: Validator<'_>, _: Tooltipped)),
    Vbv(fn(_: &Token, _: &BV, _: &Everything, _: &mut ScopeContext, _: Tooltipped)),
    Vv(fn(_: &Token, _: ValueValidator<'_>, _: &mut ScopeContext, _: Tooltipped)),
}

This enum describes what arguments an effect takes, so that they can be validated.

Since effects are so varied, many of them end up as special cases described by the VB, VBv, and VV variants. Common patterns can be captured here though.

TODO: adding a “Block” syntax similar to that in triggers may be helpful. It could remove some of the variants that currently have very few users, and it could remove some of the special cases.

Variants

Yes

No special value, just effect = yes.

Boolean

Yes and no are both meaningful. The difference between this and Effect::Yes can be hard to distinguish. TODO: needs testing.

Integer

The effect takes a literal integer. It’s not clear whether effects of this type actually exist or if they’re all secrectly Effect::ScriptValue. TODO: needs testing.

ScriptValue

The effect takes a script value, which can be a literal number or a named script value or an inline script value block.

NonNegativeValue

Just like Effect::ScriptValue, but warns if the argument is a negative literal number.

Date

The effect takes a literal date.

Scope(Scopes)

The effect takes a target value that must evaluate to a scope type in the given Scopes value.

• Example: set_county_culture = root.culture

ScopeOkThis(Scopes)

Just like Effect::Scope but it doesn’t warn if the target is a literal this. The default behavior for targets is to warn about that, because it’s usually a mistake.

• Example: destroy_artifact = this

Item(Item)

The effect takes a literal string that must exist in the item database for the given Item type.

• Example: add_perk = iron_constitution_perk

ScopeOrItem(Scopes, Item)

A combination of Effect::Scope and Effect::Item. The argument is first checked to see if it’s a literal Item, and if not, it’s evaluated as a target. This can sometimes cause strange error messages if the argument was intended to be an item but just doesn’t exist.

• Example: add_trait = cannibal
• Example: add_trait = scope:learned_trait

Target(&'static str, Scopes)

The effect takes a block that contains a single field, named here, which is a target that must evaluate to a scope type in the given Scopes value.

• Only example: becomes_independent = { change = scope:change }

TargetValue(&'static str, Scopes, &'static str)

The effect takes a block with two fields, both named here, where one specifies a target of the given Scopes type and the other specifies a script value.

• Example: change_de_jure_drift_progress = { target = root.primary_title value = 5 }

ItemTarget(&'static str, Item, &'static str, Scopes)

The effect takes a block with two fields, both named here, where one specifies a key for the given Item type and the other specifies a target of the given Scopes type.

• Example: remove_hook = { type = indebted_hook target = scope:old_caliph }

ItemValue(&'static str, Item)

The effect takes a block with two fields, both named here, where one specifies a key for the given Item type and the other specifies a script value.

• Example: set_amenity_level = { type = court_food_quality value = 3 }

Desc

The effect takes either a localization key or a description block with first_valid etc.

• Example: set_artifact_name = relic_weapon_name

Timespan

The effect takes a duration, with a days, weeks, months, or years script value.

• Example: add_destination_progress = { days = 5 }

Control

The effect takes a block that contains other effects.

• Examples: if, while, custom_description

ControlOrLabel

The effect takes either a localization key, or a block that contains other effects. This variant is used by custom_tooltip.

Unchecked

This variant is for effects that can take any argument and it’s not validated. The effect is too unusual, or not worth checking, or really any argument is fine.

• Examples: assert_if, debug_log, remove_variable

UncheckedTodo

This variant is for effects that we haven’t gotten around to validating yet.

Choice(&'static [&'static str])

The effect takes a literal string that is one of the options given here.

• Example: end_war = white_peace

Removed(&'static str, &'static str)

The effect is no longer valid; warn if it’s still being used. The first string is the game version number where it was removed and the second string is an explanation that suggests a different effect to try. The second string may be empty.

Vb(fn(_: &Token, _: &Block, _: &Everything, _: &mut ScopeContext, _: Validator<'_>, _: Tooltipped))

The effect takes a block that will be validated by this function

Vbv(fn(_: &Token, _: &BV, _: &Everything, _: &mut ScopeContext, _: Tooltipped))

The effect takes a block or value that will be validated by this function

Vv(fn(_: &Token, _: ValueValidator<'_>, _: &mut ScopeContext, _: Tooltipped))

The effect takes a value that will be validated by this function

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Effect