effects.cwt

# TODO: possibly scope[offmap]?
# TODO: <offmap_dislike> matching the <offmap>.
## scope = any
### Sets the dislike of the specified‚ offmap‚ power to the specified‚ type or random.
alias[effect:set_offmap_dislike] = {
    offmap = <offmap>
    type = <offmap_dislike>
    type = random
}

# TODO: possibly scope[offmap]?
# TODO: <offmap_like> matching the <offmap>.
## scope = any
### Sets the dislike of the specified‚ offmap‚ power to the specified‚ type or random.
alias[effect:set_offmap_like] = {
    offmap = <offmap>
    type = <offmap_like>
    type = random
}

## scope = any
### Activate a disease, which can now randomly appear. Note that there's no way to deactivate a disease.
alias[effect:activate_disease] = <disease>

## scope = any
### Activate/deactivate a titular or de jure landed title. Unlike destroyed titles (destroy_landed_title), deactivated titles cannot be re-created by the player or AI, except through special decisions.
alias[effect:activate_title] = {
    title = <title>
    status = bool
}

## scope = any
### Clears a previously set global flag.
alias[effect:clr_global_flag] = value[global_flag]

## scope = any
### Enables prepared invasions for that religion (the allow_viking_invasion property). Also see‚ disable_prepared_invasion.
alias[effect:enable_prepared_invasion] = <religion>

## scope = any
### Logs the given string for debug purposes into, game.log., Localisation commands, can be used normally in the string. Can even be used within event triggers and other places that normally only accept conditionals, such as if limit. Only logs if the game is started with the "-scriptlog" parameter.
alias[effect:log] = scalar

## scope = any
### Logs a list of all event targets set, and what each scope corresponds to into, game.log. Only logs if the game is started with the "-scriptlog" parameter.
alias[effect:log_scopes] = yes

# TODO: see if additive modifiers work
## scope = any
### An effect that might execute or not based on random chance.
alias[effect:random] = {
    ### Basic chance is equal to [value]%.
    chance = int

    ## cardinality = 0..inf
    alias_name[multiplicative_modifier] = alias_match_left[multiplicative_modifier]

    ## cardinality = 1..inf
    alias_name[effect] = alias_match_left[effect]
}

# TODO: see if additive modifiers work
## scope = any
### A list of different effects, one of which will be selected to execute based on each entry's weight (left hand side).
alias[effect:random_list] = {
    ## cardinality = 2..inf
    int = {
        ## cardinality = 0..1
        trigger = single_alias_right[trigger_clause]

        ## cardinality = 0..inf
        alias_name[multiplicative_modifier] = alias_match_left[multiplicative_modifier]

        ## cardinality = 1..inf
        alias_name[effect] = alias_match_left[effect]
    }
}

## scope = any
### Recalculates the succession.
alias[effect:recalc_succession] = yes

# TODO: make different versions for different events, because character_event and province_event are different and scopes and stuff
## scope = any
### Fires an event, without modifying the, event chain, (i.e ROOT and FROM remain unchanged). Note that it will fire the event whose id is specified, and not necessarily the current event again. See, event modding.
alias[effect:repeat_event] = {
    ### id of the event to fire.
    id = <event>

    ## cardinality = 0..1
    enum[duration_dy] = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    ## cardinality = 0..1
    ### Localisation key to show as tooltip. If not specified, uses the DEFAULT_SENDEVENT_EVENTOPTION_TOOLTIP key ("Character receives an event").
    tooltip = localisation
}

## scope = any
### Sets a global, flag.
alias[effect:set_global_flag] = value_set[global_flag]

# TODO: possibly scope[religion]?
## scope = any
### Religion becomes a heresy of new parent religion.
alias[effect:set_parent_religion] = {
    religion = <religion>
    parent = <religion>
}

## scope = any
### Plays the specified sound, as defined in interface/sound.sfx
alias[effect:sound_effect] = <sound>

## scope = any
### Forces an outbreak, but follows the scenarios set up in the disease.txt file.
alias[effect:start_outbreak] = <disease>

# TODO: implement validation
## scope = any
### Based on the evaluation of a simple (non-clause right-hand side) trigger, selects up to one of the results to happen.
alias[effect:trigger_switch] = {
    ### The LHS trigger to check.
    on_trigger = TODO

    ## cardinality = 1..inf
    ### The RHS option.
    scalar = {
        ## cardinality = 1..inf
        alias_name[effect] = alias_match_left[effect]
    }

    ## cardinality = 0..1
    ### The option to pick if none of the previous options match.
    fallback = {
        ## cardinality = 1..inf
        alias_name[effect] = alias_match_left[effect]
    }
}

## scope = any
### Bypasses some error-checking in destroy title, allowing to destroy landless titles. Warning: use this effect with care!
alias[effect:unsafe_destroy_landed_title] = scope[title]

## scope = any with flags
### Clears the given flag from the current scope. Works for any scope that can store flags, unlike the more specific clr_scope_flag commands.
# TODO: More general solution?
alias[effect:clr_flag] = value[flag]

## scope = any with flags
### Clears the given flag from the current scope. Works for any scope that can store flags, unlike the more specific clr_scope_flag commands.
# TODO: More general solution?
alias[effect:clr_flag] = value[flag]

## scope = any
### Sets a flag in the current scope if it can store flags. Works for any such scope, unlike the more specific set_scope_flag commands.
# TODO: More general solution?
alias[effect:set_flag] = value_set[flag]

## scope = title
### Sets a flag in the current scope if it can store flags. Works for any such scope, unlike the more specific set_scope_flag commands.
# TODO: More general solution?
alias[effect:set_flag] = value_set[title_flag]

## scope = artifact
### Clears a flag in the currently scoped artifact.
alias[effect:clr_artifact_flag] = value[artifact_flag]

## scope = artifact
### Copies the artifact history from the given artifact to the scoped artifact.
alias[effect:copy_artifact_history] = scope[artifact]

## scope = artifact
### Sets a flag in the currently scoped artifact.
alias[effect:set_artifact_flag] = value_set[artifact_flag]

## scope = artifact
### Sets the original owner of the artifact.
alias[effect:set_artifact_original_owner] = scope[character]

## scope = artifact
### Changes the original owner of an artifact.
alias[effect:set_original_owner] = scope[character]

## scope = artifact
### Transfers the artifact from one character to another. If from does not have the artifact, it will not be transferred.
alias[effect:transfer_artifact] = {
    from = scope[character]
    to = scope[character]
}

## scope = artifact
### Resets the description of the scoped to artifact.
alias[effect:set_description] = ""

## scope = artifact
### Changes the description of the scoped to artifact to the given localisation key. All custom localisation is resolved when set, so the description will not change once set.
alias[effect:set_description] = localisation

## scope = artifact
### Changes the description of the scoped to artifact to the given string. All custom localisation is resolved when set, so the description will not change once set.
alias[effect:set_description] = scalar

## scope = bloodline
### Resets the description of the scoped to bloodline.
alias[effect:set_description] = ""

## scope = bloodline
### Changes the description of the scoped to bloodline to the given localisation key. All custom localisation is resolved when set, so the description will not change once set.
alias[effect:set_description] = localisation

## scope = bloodline
### Changes the description of the scoped to bloodline to the given string. All custom localisation is resolved when set, so the description will not change once set.
alias[effect:set_description] = scalar

## scope = artifact
### Destroys the artifact, even if indestructible.
alias[effect:unsafe_destroy_artifact] = yes

# TODO see if scope[artifact] works
## scope = any
### Destroys the artifact, even if indestructible.
alias[effect:unsafe_destroy_artifact] = <artifact>

# TODO Confirm it works that way
## scope = unit
### Changes the current tactic of the unit. Totally ignores the triggers or phases. If the tactic has a phase change part then that part will be acknowledged however.
alias[effect:set_flank_tactic] = <combat_tactic>

## scope = bloodline
### Add the specified character to the scoped bloodline
alias[effect:add_bloodline_member] = scope[character]

## scope = bloodline
### Removes a script flag from the scoped bloodline
alias[effect:clr_bloodline_flag] = value[bloodline_flag]

## scope = bloodline
### Removed the scoped bloodline from the game.
alias[effect:destroy_bloodline] = yes

## scope = bloodline
### Remove the specified character from the scoped bloodline.
alias[effect:remove_bloodline_member] = character

## scope = bloodline
### Adds a script flag to the scoped bloodline.
alias[effect:set_bloodline_flag] = value_set[bloodline_flag]

## scope = character
### Abdicate to current heir
alias[effect:abdicate] = yes

# TODO: Figure out what the clause does.
## scope = character
### Abdicate to current heir
alias[effect:abdicate] = {
    move = no
}

## scope = character
### Abdicate to an arbitrary character.
alias[effect:abdicate_to] = scope[character]

# TODO: Figure out
## scope = character
### UNKNOWN
alias[effect:abdicate_to_most_liked_by] = scope[character]

## scope = character
### For plots activated by decision
alias[effect:activate_plot] = yes

## scope = character
### Adds the given value to the age of the scoped character. Warning: messing with a character's age may have unintended side effects so use with caution.
alias[effect:add_age] = int

## scope = character
### Creates an alliance between characters. Also see break_alliance.
alias[effect:add_alliance] = {
    who = scope[character]
    enum[duration] = int
}

## scope = character
###
alias[effect:add_ambition] = <objective.ambition>

## scope = character
### A copy of the named artifact is created and added to the scoped character.
alias[effect:add_artifact] = <artifact>

## scope = character
### Warn: buggy behavior
alias[effect:add_betrothal] = <character>

# TODO: pay attention to the type for name field, might be wrong
# TODO: Also write an alias for "either duration = -1 or days/months/years"
# TODO: docs.
## scope = character
### Adds a, character modifier. Specify duration using, days,, months,, years, or, duration = -1, (non-expiring). Can use optional fields, hidden = yes, and, stacking = yes.
alias[effect:add_character_modifier] = {
    enum[modifier_names] = <event_modifier>
    ## cardinality = 0..1
    enum[duration_dmy] = -1
    ## cardinality = 0..1
    enum[duration_dmy] = int
    ## cardinality = 0..1
    enum[duration] = int
    ## cardinality = 0..1
    hidden = bool
    ## cardinality = 0..1
    stacking = bool
    ## cardinality = 0..1
    inherit = bool
}

## scope = character
### Adds the given character as a consort to the scoped character.
alias[effect:add_consort] = scope[character]

## scope = character
### Makes scoped character be owed a favor toward another character. Also see, reverse_add_favor.
alias[effect:add_favor] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Makes the scoped character a friend of the given character.
alias[effect:add_friend] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Makes the scoped character a lover of the given character.
alias[effect:add_lover] = scope[character]

## scope = character
###
alias[effect:add_objective] = TODO

# TODO see if scope[offmap] works
## scope = character
### Adds the specified, amount, of offmap currency for the specified, offmap, power to the scoped character. Use a negative number to subtract.
alias[effect:add_offmap_currency] = {
    offmap = <offmap>
    value = int
}

## scope = character
### Adds or subtracts a portion of the scope's population.
alias[effect:add_population_scaled] = float

## scope = character
### Adds an education trait matching specified attribute.
alias[effect:add_random_education_trait] = enum[attributes]

# TODO: see if int is really strictly 1..4
## scope = character
### Adds an education trait matching specified level.
alias[effect:add_random_education_trait] = int[1..4]

# TODO: Confirm
## scope = character
### Adds a random education trait.
alias[effect:add_random_education_trait] = yes

# TODO: Confirm
## scope = character
### UNCONFIRMED Makes the scoped character a rival of the given character. See also remove_rival.
alias[effect:add_rival] = scope[character]

## scope = character
### Adds a timed modifier to the society of scoped character. Works with days and years.
alias[effect:add_society_modifier] = {
    modifier = <static_modifier>
    alias_name[duration] = alias_match_left[duration]
    ## cardinality = 0..1
    enum[duration_duy] = int
}

# TODO: Confirm
## scope = character
### UNCONFIRMED Makes the scoped character a spouse of the given character (normal marriage).
alias[effect:add_spouse] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Makes the scoped character a spouse of the given character (matrilineal marriage).
alias[effect:add_spouse_matrilineal] = scope[character]

## scope = character
### Add the scoped character to the RHS bloodline. Note that the RHS must be an existing bloodline, not a bloodline type.
alias[effect:add_to_bloodline] = scope[bloodline]

## scope = character
### Adds a trait to the character, using an ID from the traits files. Also see, remove_trait.
alias[effect:add_trait] = <trait>

# TODO: Figure out
## scope = character
###
alias[effect:ambition_succeeds] = yes

# TODO: Figure out
## scope = character
###
alias[effect:back_plot] = scope[character]

## scope = character
### Banish character to random court. See also remove_banish.
alias[effect:banish] = yes

# TODO: Possibly scope[religion]?
## scope = character
### All characters of the targeted religion will be banished to random court
alias[effect:banish_religion] = <religion>

## scope = character
### Changes character religion to a random heresy of current religion
alias[effect:become_heretic] = yes

## scope = character
### Changes character religion to a heresy of their current religion, but still openly practices their current faith (i.e., similar to become_heretic, but in secret rather than openly).
alias[effect:become_secret_heretic] = yes

## scope = character
### Remove an alliance. Also see, add_alliance
alias[effect:break_alliance] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Breaks the betrothal between the scoped character and the target character
alias[effect:break_betrothal] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Cancels the current ambition of the scoped character.
alias[effect:cancel_ambition] = yes

# TODO: Docs and Figure out
## scope = character
### UNKNOWN
alias[effect:cancel_job_action] = <job_action>

## scope = character
### Outdated, now cancel_objective/cancel_plot
alias[effect:cancel_objective] = TODO

## scope = character
###
alias[effect:cancel_plot] = <objective.plot>

## scope = character
### Ends a character's pregnancy instantaneously. Can be called at any time during pregnancy prior to birth. If pregnancy notification is to be avoided, must be called earlier than 2 months pregnancy.
alias[effect:cancel_pregnancy] = yes

## scope = character
### Moves the capital.
alias[effect:capital] = enum[provinces]

## scope = character
### Moves the capital.
alias[effect:capital] = scope[province]

## scope = character
### Changes base diplomacy stat. Will not decrease base stat below 0.
alias[effect:change_diplomacy] = int

## scope = character
### Changes base martial stat. Will not decrease base stat below 0.
alias[effect:change_martial] = int

## scope = character
### Changes base stewardship stat. Will not decrease base stat below 0.
alias[effect:change_stewardship] = int

## scope = character
### Changes base intrigue stat. Will not decrease base stat below 0.
alias[effect:change_intrigue] = int

## scope = character
### Changes base learning stat. Will not decrease base stat below 0.
alias[effect:change_learning] = int

## scope = character
### Add or remove threat from a character.
alias[effect:change_infamy] = {
    value = float
    ### Key for the localisation entry for the character's threat tooltip.
    localisation = localisation
}

## scope = character
### Add the specified amount of plot power to the plot owned by the scoped character.
alias[effect:change_plot_power] = int

## scope = character
### Changes the currency of the scoped character in their society.
alias[effect:change_society_currency] = int

## scope = character
### Changes the currency of the scoped character in their society, reducing the amount of currency consumed (or given, but is intended for the former) by 70% when the society is at 100% influence, going linearly from 0% at 0%.
alias[effect:change_society_currency] = {
    society = <society>
    value = int
    scaled_by_influence = yes
}

# TODO: See if months works
## scope = character
### Fires an event for the scoped character.
alias[effect:character_event] = {
    id = <event.character>
    id = <event.long_character>
    id = <event.letter_event>

    ## cardinality = 0..1
    enum[duration_dy] = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    ## cardinality = 0..1
    ### Tooltip for the effect. If not specified, uses the DEFAULT_SENDEVENT_EVENTOPTION_TOOLTIP key ("Character receives an event").
    tooltip = localisation
}

# TODO: See if months works
## scope = character
### Fires an event for the scoped character.
alias[effect:long_character_event] = {
    id = <event.character>
    id = <event.long_character>

    ## cardinality = 0..1
    enum[duration_dy] = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    ## cardinality = 0..1
    ### Tooltip for the effect. If not specified, uses the DEFAULT_SENDEVENT_EVENTOPTION_TOOLTIP key ("Character receives an event").
    tooltip = localisation
}

# TODO: Elaborate.
## scope = character
### Records a chronicle entry.
alias[effect:chronicle] = {
    entry = localisation

    ## cardinality = 0..1
    portrait = TODO # localisation as scalar?

    ## cardinality = 0..1
    picture = <sprite>
}

## scope = character
### Removes all opinion modifiers allowing the scoped character to banish the given character. Doesn't clear ongoing reasons like excommunication.
alias[effect:clear_banish_reasons] = scope[character]

## scope = character
### Removes all traits with the, education = yes, parameter.
alias[effect:clear_education_trait] = yes

## scope = character
### Removes all opinion modifiers allowing the scoped character to execute the given character. Doesn't clear ongoing reasons like excommunication.
alias[effect:clear_execute_reasons] = scope[character]

## scope = character
### Removes the focus of a character. Also see, set_focus.
alias[effect:clear_focus] = yes

## scope = character
### Removes all opinion modifiers allowing the scoped character to imprison the given character. Doesn't clear ongoing reasons like excommunication.
alias[effect:clear_prison_reasons] = scope[character]

## scope = character
### Removes all opinion modifiers allowing the scoped character to revoke the given character's titles. Doesn't clear ongoing reasons like excommunication.
alias[effect:clear_revoke_reasons] = scope[character]

## scope = character
### Removes the scoped character's secret religion.
alias[effect:clear_secret_religion] = yes

## scope = character
### Sets wealth of the scoped character to 0.
alias[effect:clear_wealth] = yes

## scope = any
### Sets wealth of the given character to 0.
alias[effect:clear_wealth] = scope[character]

## scope = character
### Clears a previously set flag in the scoped character.
alias[effect:clr_character_flag] = value[character_flag]

## scope = character
### Resets the character's revealed society.
alias[effect:clr_discovered_society] = yes

## scope = character
### Removes any quest with that name belonging to the scoped character, considered a success.
alias[effect:clr_quest] = value[quest]

## scope = character
### Removes any quest with that name (and from that society, if the society name is present) belonging to the scoped character, considered a failure.
alias[effect:clr_quest] = {
    ## cardinality = 0..1
    society = <society>
    id = value[quest]
    failure = yes
}

## scope = character
### Clears the target of the specified quest belonging to the scoped character. Does not clear the quest itself.
alias[effect:clr_quest_target] = value[quest]

## scope = character
### Sets the scoped character's public religion to their secret religion.
alias[effect:convert_to_secret_religion] = yes

## scope = character
### Sets the scoped character's public religion to the given character's secret religion.
alias[effect:convert_to_secret_religion] = scope[character]

# TODO: Confirm
## scope = character
### UNCONFIRMED Copies a random trait with personality = yes from the given character.
alias[effect:copy_random_personality_trait] = scope[character]

# TODO: Probably scope[religion] but we'll see.
## scope = character
### Scoped character founds a new bloodline of the specified type.
alias[effect:create_bloodline] = {
    type = <bloodline>

    ## cardinality = 0..1
    ### Associates the bloodline with a religion, connecting it with the religion view.
    religion = <religion>

    ## cardinality = 0..1
    ### Associates the bloodline with a society, connecting it with the society view.
    society = <society>

    ## cardinality = 0..1
    ### Overrides the base type's inheritance rules.
    inheritance = enum[bloodline_inheritance_types]

    ## cardinality = 0..1
    ### Overrides the base type's bastard rules.
    allow_bastards = bool
}

## scope = character
### Creates the patrician family palace
alias[effect:create_family_palace] = yes

# TODO: Confirm
## scope = character
###
alias[effect:culture_techpoints] = int

# TODO: Confirm
## scope = character
###
alias[effect:cure_illness] = yes

## scope = character
### Kills the scoped character.
alias[effect:death] = {
    death_reason = <death>

    # Cardinality probably depends on can_no_killer of the death reason?
    ## cardinality = 0..1
    killer = scope[character]
}

# TODO: Confirm
## scope = character
### UNCONFIRMED Changes the scoped character's decadence by this amount.
alias[effect:decadence] = int

## scope = character
### Also see, approve_law.
alias[effect:decline_law] = TODO

## scope = character
### Destroys the tradepost in the given province.
alias[effect:destroy_tradepost] = scope[province]

# TODO: Figure out
## scope = character
###
alias[effect:diplomatic_immunity] = yes

## scope = character
### Disables prepared invasions for that religion (the allow_viking_invasion property). Also see‚ enable_prepared_invasion.
alias[effect:disable_prepared_invasion] = <religion>

## scope = character
### Disbands the levies previously created with the given earmark via spawn_unit = { earmark = xxx }
alias[effect:disband_event_forces] = value[earmark]

# TODO: Docs ... Strange, used in CB_Types
## scope = character
###
alias[effect:disband_event_forces] = bool

## scope = character
### Sets the dynasty of scoped character. May need to been chained with recalc_succession command, if impacting succession. Use, dynasty = father_bastard, to generate a cadet dynasty,, dynasty = mother_bastard, to create a bastard dynasty, or, dynasty = none, to make the character Lowborn. Special values used in character creation (""random"", ""culture"", and ""actually_culture"") do, not, work here. When setting character dynasty in an event it only works inside of an immediate = { } block.
alias[effect:dynasty] = scope[character]

# TODO: Confirm
## scope = character
###
alias[effect:economy_techpoints] = int

# TODO: Confirm
## scope = character
###
alias[effect:embargo] = scope[character]

# TODO: Confirm - bool or yes?
## scope = character
###
alias[effect:excommunicate] = yes

## scope = character
###
alias[effect:faction] = <objective.faction>

# TODO: Confirm
## scope = character
###
alias[effect:fertility] = float

## scope = character
### Similar to move_character, but it bypasses the checks and forces the character to move. Should not be used lightly.
alias[effect:force_host] = scope[character]

# TODO: Confirm
## scope = character
###
alias[effect:gain_all_occupied_titles] = scope[character]

# TODO: Confirm scopes and whatever this does anyway
## scope = character
### Note: Does not work with "any_" scopes.
alias[effect:gain_settlements_under_title] = {
    title = scope[title]
    enemy = scope[character]
}

# TODO: Confirm
## scope = character
###
alias[effect:give_job_title] = <minor_title.job>

# TODO: Confirm
## scope = character
###
alias[effect:give_minor_title] = <minor_title>

## scope = character
### gives the character a nickname.
alias[effect:give_nickname] = <nickname>

# TODO: Confirm
## scope = character
###
alias[effect:health] = float

# TODO: Confirm
## scope = character
### For merchant republics.
alias[effect:hold_election] = yes

## scope = character
### Scope gets impregnated by the character.
alias[effect:impregnate] = scope[character]

## scope = character
### Scope gets impregnated with no specified father.
alias[effect:impregnate] = 0

## scope = character
###
alias[effect:impregnate_cuckoo] = scope[character]

## scope = character
### Scoped character will be imprisoned by target. Identical to the "prisoner" command.
alias[effect:imprison] = scope[character]

# TODO: Confirm it's "current" and not "correct" (original)
## scope = character
### Scoped character will be imprisoned in the current location. Identical to the "prisoner" command.
alias[effect:imprison] = yes

## scope = character
### Scoped character will be released from prison. Identical to the "prisoner" command.
alias[effect:imprison] = no

## scope = character
### Scoped character will inherit titles of target character.
alias[effect:inherit] = scope[character]

# TODO: Confirm
## scope = character
###
alias[effect:join_attacker_wars] = scope[character]

# TODO: Confirm
## scope = character
### Only joins one war. Cannot be used by (feudal?) vassals to join liege's war.
alias[effect:join_defender_wars] = scope[character]

## scope = character
### Joins the faction led by the faction leader, if it exists. Also supports the optional argument
alias[effect:join_faction] = <objective.faction>

## scope = character
### Joins the specified society.
alias[effect:join_society] = <society>

## scope = character
###
alias[effect:leave_faction] = <objective.faction>

# TODO: Confirm
## scope = character
###
alias[effect:leave_plot] = scope[character]

## scope = character
### Makes the scoped character leave the society they are currently part of.
alias[effect:leave_society] = yes

## scope = character
### Fires an event to scoped character.
alias[effect:letter_event] = {
    id = <event.letter>

    ## cardinality = 0..1
    enum[duration_dy] = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    ## cardinality = 0..1
    ### Tooltip for the effect. If not specified, uses the DEFAULT_SENDEVENT_EVENTOPTION_TOOLTIP key ("Character receives an event").
    tooltip = localisation
}

## scope = character
### The scoped character will become primary spouse.
alias[effect:make_primary_spouse] = yes

## scope = character
### The scoped character will become a suzerain to "who".
alias[effect:make_tributary] = {
    ### This will become the tributary.
    who = scope[character]

    ## cardinality = 0..1
    ### What percentage of tribute the tributary type pays to their liege. Defaults to the tributary_type's values.
    percentage = float

    ## cardinality = 0..1
    ### Determines the suzerain-tributary relationship type. Defaults to "default".
    tributary_type = <tributary_type>
}

## scope = character
### Increase/decrease manpower.
alias[effect:manpower] = int

# TODO: Confirm
## scope = character
###
alias[effect:military_techpoints] = int

## scope = character
### The scoped character will be moved to targeted characters court
alias[effect:move_character] = scope[character]

## scope = character
### Fires an event to scoped character.
alias[effect:narrative_event] = {
    id = <event.narrative>

    ## cardinality = 0..1
    enum[duration_dy] = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    ## cardinality = 0..1
    ### Tooltip for the effect. If not specified, uses the DEFAULT_SENDEVENT_EVENTOPTION_TOOLTIP key ("Character receives an event").
    tooltip = localisation
}

# TODO: Confirm
## scope = character
###
alias[effect:occupy_minors_of_occupied_settlements] = scope[character]

## scope = character
### Adds an, opinion modifier, to the scoped character towards "who".
alias[effect:opinion] = {
    modifier = <opinion_modifier>

    who = scope[character]

    ## cardinality = 0..1
    ### Can be used to customise localisation that appears in the tooltip.
    origin_description = localisation

    ## cardinality = 0..1
    ### Overrides the default duration of the opinion modifier.
    enum[duration_my] = int

    # TODO: Docs and confirm int rather than multiplier
    ## cardinality = 0..1
    ###
    multiplier = int
}

## scope = character
### Adds an, opinion modifier, to the scoped character towards "who".
alias[effect:opinion] = {
    name = <opinion_modifier>

    who = scope[character]

    ## cardinality = 0..1
    ### Can be used to customise localisation that appears in the tooltip.
    origin_description = localisation

    ## cardinality = 0..1
    ### Overrides the default duration of the opinion modifier.
    enum[duration_my] = int

    # TODO: Docs and confirm int rather than multiplier
    ## cardinality = 0..1
    ###
    multiplier = int
}

# TODO: Confirm
## scope = character
###
alias[effect:participation_scaled_decadence] = float

# TODO: Confirm
## scope = character
###
alias[effect:participation_scaled_piety] = float

# TODO: Confirm
## scope = character
###
alias[effect:participation_scaled_prestige] = float

## scope = character
### Adds the given amount of piety to the character.
alias[effect:piety] = int

## scope = character
### Tells the plot system to end the plot and fire the, effect, block. Note that it doesn't cause a plot to succeed, it should be used when a plot has already succeeded (successcondition block).
alias[effect:plot_succeeds] = yes

# TODO: Confirm
## scope = character
###
alias[effect:population] = int

## scope = character
### Removes a, character modifier
# TODO: character event modifiers only
alias[effect:remove_character_modifier] = <event_modifier>

## scope = character
### Removes a number of instances of a, character modifier, (usually a stackable one).
alias[effect:remove_character_modifiers] = {
    modifier = <event_modifier>
    amount = int
}

## scope = character
### Removes the consort/concubine relationship between the scoped and the given characters. Works in either scope.
alias[effect:remove_consort] = scope[character]

## scope = character
### Target character no longer owes a favor to the scoped character. Also see, reverse_remove_favor.
alias[effect:remove_favor] = scope[character]

## scope = character
### Removes a friend relationship between the scoped and the given characters.
alias[effect:remove_friend] = scope[character]

## scope = character
### Remove the scoped character from the specified bloodline.
alias[effect:remove_from_bloodline] = scope[bloodline]

## scope = character
### Remove scoped character's guardian.
alias[effect:remove_guardian] = scope[character]

## scope = character
### Remove scoped character's lover.
alias[effect:remove_lover] = scope[character]

## scope = character
### Remove character's nickname.
alias[effect:remove_nickname] = yes

## scope = character
### Remove character's nickname if it is the given one.
alias[effect:remove_nickname] = <nickname>

## scope = character
### Removes an, opinion modifier towards "who" from scoped character.
alias[effect:remove_opinion] = {
    who = scope[character]
    modifier = <opinion_modifier>
}

## scope = character
### Makes the scoped character no longer rival of the given character. See also add_rival.
alias[effect:remove_rival] = scope[character]

## scope = character
### Removes special title from scoped character. See also set_special_character_title.
alias[effect:remove_special_character_title] = localisation

## scope = character
### Remove scoped character's spouse.
alias[effect:remove_spouse] = yes

## scope = character
### Remove the scoped character's spouse that matches the given character.
alias[effect:remove_spouse] = scope[character]

## scope = character
### Remove minor title.
alias[effect:remove_title] = <minor_title>

## scope = character
### Removes a trait, also see, add_trait.
alias[effect:remove_trait] = <trait>

## scope = character
### Stops the scoped character from being a tributary to the given character.
alias[effect:remove_tributary] = scope[character]

## scope = character
### Reveals the scoped character's plot.
alias[effect:reveal_plot] = yes

## scope = character
### Reveals the scoped character's plot to the given character.
alias[effect:reveal_plot] = scope[character]

# TODO: Figure out
## scope = character
### reveal scoped characters plot
alias[effect:reveal_plot_w_message] = yes

## scope = character
### Makes scoped character owe a favor to the given character. Also see, add_favor.
alias[effect:reverse_add_favor] = scope[character]

# TODO confirm actual behaviour - where do they actually go, ect.
## scope = character
### Bring scoped character back into court. See also banish.
alias[effect:reverse_banish] = scope[character]

## scope = character
### The given character will be imprisoned by the scoped character
alias[effect:reverse_imprison] = scope[character]

## scope = character
### Adds an, opinion modifier, to "who" towards scoped character.
alias[effect:reverse_opinion] = {
    modifier = <opinion_modifier>

    who = scope[character]

    ## cardinality = 0..1
    ### Can be used to customise localisation that appears in the tooltip.
    origin_description = localisation

    ## cardinality = 0..1
    ### Overrides the default duration of the opinion modifier.
    enum[duration_my] = int
}

## scope = character
### Scoped character no longer owes a favor to the given character. Also see, remove_favor.
alias[effect:reverse_remove_favor] = scope[character]

## scope = character
### Removes an, opinion modifier towards scoped character from "who".
alias[effect:reverse_remove_opinion] = {
    who = scope[character]
    modifier = <opinion_modifier>
}

# TODO update for thirdparty stuff when I do that
## scope = character
### Initiate a war; target is the attacker, the scoped character is the defender. Doesn't check if the casus belli can be used.
alias[effect:reverse_unsafe_war] = {
    target = scope[character]
    casus_belli = <casus_belli>
    ## cardinality = 0..1
    thirdparty = scope[character]
    ## cardinality = 0..1
    ### Overrides the resulting threat value.
    infamy = int # TODO: is it really int?
}

## scope = character
### Modifies piety by percentage (1.0 = 100%) of annual piety increase.
alias[effect:scaled_piety] = float

## scope = character
### Modifies piety by value percentage (1.0 = 100%) of annual piety increase. min increases final cost to min if result would be lower. max reduces the final cost to max if result would be lower.
alias[effect:scaled_piety] = {
    value = float
    ## cardinality = 0..1
    min = int
    ## cardinality = 0..1
    max = int
}

## scope = character
### Modifies prestige by percentage (1.0 = 100%) of annual prestige increase.
alias[effect:scaled_prestige] = float

## scope = character
### Modifies prestige by value percentage (1.0 = 100%) of annual prestige increase. min increases final cost to min if result would be lower. max reduces the final cost to max if result would be lower.
alias[effect:scaled_prestige] = {
    value = float
    ## cardinality = 0..1
    min = int
    ## cardinality = 0..1
    max = int
}

## scope = character
### Modifies wealth by percentage (1.0 = 100%) of annual wealth increase.
alias[effect:scaled_wealth] = float

## scope = character
### Modifies wealth by value percentage (1.0 = 100%) of annual wealth increase. min increases final cost to min if result would be lower. max reduces the final cost to max if result would be lower.
alias[effect:scaled_wealth] = {
    value = float
    ## cardinality = 0..1
    min = int
    ## cardinality = 0..1
    max = int
}

# TODO: Figure out
## scope = character
###
alias[effect:send_assassin] = scope[character]

## scope = character
### Sets a flag in the scoped character.
alias[effect:set_character_flag] = value_set[character_flag]

# TODO: Figure out
## scope = character
###
alias[effect:set_defacto_vassal] = scope[character]

# TODO: Figure out
## scope = character
###
alias[effect:set_defacto_vassal] = scope[title]

## scope = character
### Sets the character to be revealed to be part of their secret society.
alias[effect:set_discovered_society] = yes

## scope = character
### Sets the character to be "revealed" to be part of the given society.
alias[effect:set_discovered_society] = scope[society]

## scope = character
### Sets a flag in the scoped character's dynasty.
alias[effect:set_dynasty_flag] = value_set[dynasty_flag]

## scope = character
### Change the father of a character.
alias[effect:set_father] = scope[character]

## scope = character
### Remove the father of a character.
alias[effect:set_father] = 0

## scope = character
### Sets the focus of a character.
alias[effect:set_focus] = <objective.focus>

## scope = character
### Sets the scoped character's gender to be male. Warning: messing with a character's gender may have unintended side effects so use with caution.
alias[effect:set_gender] = male

## scope = character
### Sets the scoped character's gender to be female. Warning: messing with a character's gender may have unintended side effects so use with caution.
alias[effect:set_gender] = female

## scope = character
### Sets the scoped character's gender to be the opposite of what they currently are. Warning: messing with a character's gender may have unintended side effects so use with caution.
alias[effect:set_gender] = opposite

## scope = character
### Change the government type of the scoped character.
alias[effect:set_government_type] = <government>

## scope = character
### Sets the ethnicity of the scoped character, based on the default graphical_culture of a culture, or of the culture of another character or province.
alias[effect:set_graphical_culture] = scope[culture]

# TODO: Confirm
## scope = character
###
alias[effect:set_guardian] = scope[character]

## scope = character
### Sets a character as important. They will neither be removed from AI courts nor be deleted from the saved game to reduce file size. WARNING: This cannot be reversed.
alias[effect:set_immune_to_pruning] = yes

## scope = character
### Make a character interested in joining the specified society.
alias[effect:set_interested_society] = scope[society]

# TODO: Confirm. I suspect where is optional based on whether the job action is landless or not, but *shrug*
## scope = character
### Update the current job of a councillor.
alias[effect:set_job_action] = {
    action = <job_action>
    where = scope[province]
}

## scope = character
### Change the mother of a character.
alias[effect:set_father] = scope[character]

# TODO: Confirm. Actually copied from mother, dunno if 0 works.
## scope = character
### Remove the mother of a character.
alias[effect:set_father] = 0

## scope = character
### Sets the scoped character's total amount of offmap currency for the specified, offmap power to the, value.
alias[effect:set_offmap_currency] = {
    offmap = scope[offmap]
    value = int
}

# TODO: Figure out
## scope = character
###
alias[effect:set_opinion_levy_raised_days] = {
    who = scope[character]
    days = int
}

## scope = character
### The player controlling the scoped character starts controlling the given character instead. Does not enforce remaining within the same dynasty, but chronicle will be lost if dynasty changes., WARNING: It's possible to cause game overs with this so use with care.
alias[effect:set_player_character] = scope[character]

## scope = character
### Creates a quest for the scoped character.
alias[effect:set_quest] = value_set[quest]

## scope = character
### Creates a quest with the given society for the scoped character.
alias[effect:set_quest] = {
    id = value_set[quest]
    society = scope[society]
}

## scope = character
### When a child is denounced (no official father), real_father is used to keep track of it.
alias[effect:set_real_father] = scope[character]

# TODO: Figure out
## scope = character
###
alias[effect:set_reincarnation] = scope[character]

# TODO: Figure out
## scope = character
###
alias[effect:set_reincarnation] = 0

## scope = character
### Sets the secret religion of the character to the right-hand-side (defaulting to secret religion, if applicable).
alias[effect:set_secret_religion] = scope[religion]

## scope = character
### Sets the secret religion of the character to the right-hand-side, using the specified visibility religion of the target.
alias[effect:set_secret_religion] = {
    target_type = enum[religion_visibility]
    target = scope[religion]
}

## scope = character
### Set or unset the scoped character as the grandmaster of their society.
alias[effect:set_society_grandmaster] = yes

## scope = character
### Unset the scoped character as the grandmaster of their society.
alias[effect:set_society_grandmaster] = no

## scope = character
### Add special title to scoped character. See also remove_special_character_title.
alias[effect:set_special_character_title] = localisation

# TODO: See if other durations work
## scope = character
### Gives a temporary truce to the scoped character towards "who".
alias[effect:set_truce] = {
    who = scope[character]
    years = int
}

## scope = character
### Ranks the scoped character down by the specified number of ranks in their current society.
alias[effect:society_rank_down] = int

## scope = character
### Ranks the scoped character down by the specified number of ranks in the given society.
alias[effect:society_rank_down] = {
    society = scope[society]
    rank = int
}

## scope = character
### Ranks the scoped character up by the specified number of ranks in their current society.
alias[effect:society_rank_up] = int

## scope = character
### Ranks the scoped character up by the specified number of ranks in the given society.
alias[effect:society_rank_up] = {
    society = scope[society]
    rank = int
}

# TODO: Confirm scope! And figure out what some of the properties mean
## scope = character
### Spawns a fleet under the given character's control in the specified province.
alias[effect:spawn_fleet] = {
    province = scope[province]

    owner = scope[character]

    ### Can be localised somehow probably
    earmark = value_set[earmark]

    troops = {
        ## cardinality = 1..inf
        ### troop_type = { max_value starting_value }
        enum[troop_types_sea_only] = {
            ## cardinality = 2..2
            int[1..inf]
        }
    }

    ## cardinality = 0..1
    match_character = scope[character]

    ## cardinality = 0..1
    ### "Matches against the total levies of every single holding"
    match_mult = float

    ## cardinality = 0..1
    match_min = float

    ## cardinality = 0..1
    ### Probably - If yes, disbands on peace. Defaults to "no".
    disband_on_peace = bool

    ## cardinality = 0..1
    ### Probably - If yes, disbands on owner death. Defaults to "no".
    cannot_inherit = bool
}

# TODO: Confirm scope! And figure out what some of the properties mean
## scope = character
### Spawns a fleet under the given character's control in the closest province.
alias[effect:spawn_fleet] = {
    province = closest

    owner = scope[character]

    ### Can be localised somehow probably
    earmark = value_set[earmark]

    troops = {
        ## cardinality = 1..inf
        ### troop_type = { max_value starting_value }
        enum[troop_types_sea_only] = {
            ## cardinality = 2..2
            int[1..inf]
        }
    }

    ## cardinality = 0..1
    match_character = scope[character]

    ## cardinality = 0..1
    ### "Matches against the total levies of every single holding"
    match_mult = float

    ## cardinality = 0..1
    match_min = float

    ## cardinality = 0..1
    ### Probably - If yes, disbands on peace. Defaults to "no".
    disband_on_peace = bool

    ## cardinality = 0..1
    ### Probably - If yes, disbands on owner death. Defaults to "no".
    cannot_inherit = bool
}

# TODO: Confirm scope! And figure out what some of the properties mean
## scope = character
### Spawns an army under the given character's control in the specified province.
alias[effect:spawn_unit] = {
    province = scope[province]

    ## cardinality = 0..1
    home = scope[province]

    owner = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be "none".
    leader = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be a character scope.
    leader = none

    ## cardinality = 0..1
    ### ID of the unit, to be able to reference them later. Can be localized via $_ARMY and $_ARMY_OF.
    earmark = value_set[earmark]

    ## cardinality = 0..1
    troops = {
        ## cardinality = 1..inf
        ### troop_type = { max_value starting_value }
        enum[troop_types_land_only] = {
            ## cardinality = 2..2
            int[1..inf]
        }
    }

    ## cardinality = 0..1
    ### Character to match against for match_mult.
    match_character = scope[character]

    ## cardinality = 0..1
    ### Proportional amount of troops to match_character total levy size (levies and event troops).
    match_mult = float

    ## cardinality = 0..1
    match_max = float

    ## cardinality = 0..1
    match_min = float

    ## cardinality = 0..1
    ### Probably - If yes, disbands on peace. Defaults to "no".
    disband_on_peace = bool

    ## cardinality = 0..1
    ### Probably - If yes, disbands on owner death. Defaults to "no".
    cannot_inherit = bool

    ## cardinality = 0..1
    ### Attrition multiplier (1.0 for normal, 0 for attrition-less).
    attrition = float[0.0..inf]

    ## cardinality = 0..1
    ### Will have normal maintenance cost multiplied by this value.
    maintenance_multiplier = float

    ## cardinality = 0..1
    scaled_by_biggest_garrison = float

    ## cardinality = 0..1
    ### If yes, merge all the regiments in this province together into one army. Defaults to "no".
    merge = bool

    ## cardinality = 0..1
    can_toggle_looting = bool

    ## cardinality = 0..1
    is_looter = bool

    ## cardinality = 0..1
    ### If yes, the unit can reinforce. Defaults to "no".
    reinforces = bool

    ## cardinality = 0..1
    reinforce_rate_multiplier = float

    ## cardinality = 0..1
    maintenance = bool
}

# TODO: Confirm scope! And figure out what some of the properties mean
## scope = character
### Spawns an army under the given character's control in the closest province.
alias[effect:spawn_unit] = {
    province = closest

    home = scope[province]

    owner = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be "none".
    leader = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be a character scope.
    leader = none

    ## cardinality = 0..1
    ### ID of the unit, to be able to reference them later. Can be localized via $_ARMY and $_ARMY_OF.
    earmark = value_set[earmark]

    troops = {
        ## cardinality = 1..inf
        ### troop_type = { max_value starting_value }
        enum[troop_types_land_only] = {
            ## cardinality = 2..2
            int[1..inf]
        }
    }

    ## cardinality = 0..1
    ### Character to match against for match_mult.
    match_character = scope[character]

    ## cardinality = 0..1
    ### Proportional amount of troops to match_character total levy size (levies and event troops).
    match_mult = float

    ## cardinality = 0..1
    match_max = float

    ## cardinality = 0..1
    match_min = float

    ## cardinality = 0..1
    ### Probably - If yes, disbands on peace. Defaults to "no".
    disband_on_peace = bool

    ## cardinality = 0..1
    ### Probably - If yes, disbands on owner death. Defaults to "no".
    cannot_inherit = bool

    ## cardinality = 0..1
    ### Attrition multiplier (1.0 for normal, 0 for attrition-less).
    attrition = float[0.0..inf]

    ## cardinality = 0..1
    ### Will have normal maintenance cost multiplied by this value.
    maintenance_multiplier = float

    ## cardinality = 0..1
    scaled_by_biggest_garrison = float

    ## cardinality = 0..1
    ### If yes, merge all the regiments in this province together into one army. Defaults to "no".
    merge = bool

    ## cardinality = 0..1
    can_toggle_looting = bool

    ## cardinality = 0..1
    is_looter = bool

    ## cardinality = 0..1
    ### If yes, the unit can reinforce. Defaults to "no".
    reinforces = bool

    ## cardinality = 0..1
    reinforce_rate_multiplier = float

    ## cardinality = 0..1
    maintenance = bool
}

# TODO: Confirm scope! And figure out what some of the properties mean
## scope = character
### Spawns an army under the given character's control in the the province closest to the capital.
alias[effect:spawn_unit] = {
    province = scope[province]

    home = scope[province]

    owner = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be "none".
    leader = scope[character]

    ## cardinality = 0..1
    ### Defaults to the scoped character. Also can be a character scope.
    leader = none

    ## cardinality = 0..1
    ### ID of the unit, to be able to reference them later. Can be localized via $_ARMY and $_ARMY_OF.
    earmark = value_set[earmark]

    troops = {
        ## cardinality = 1..inf
        ### troop_type = { max_value starting_value }
        enum[troop_types_land_only] = {
            ## cardinality = 2..2
            int[1..inf]
        }
    }

    ## cardinality = 0..1
    ### Character to match against for match_mult.
    match_character = scope[character]

    ## cardinality = 0..1
    ### Proportional amount of troops to match_character total levy size (levies and event troops).
    match_mult = float

    ## cardinality = 0..1
    match_max = float

    ## cardinality = 0..1
    match_min = float

    ## cardinality = 0..1
    ### Probably - If yes, disbands on peace. Defaults to "no".
    disband_on_peace = bool

    ## cardinality = 0..1
    ### Probably - If yes, disbands on owner death. Defaults to "no".
    cannot_inherit = bool

    ## cardinality = 0..1
    ### Attrition multiplier (1.0 for normal, 0 for attrition-less).
    attrition = float[0.0..inf]

    ## cardinality = 0..1
    ### Will have normal maintenance cost multiplied by this value.
    maintenance_multiplier = float

    ## cardinality = 0..1
    scaled_by_biggest_garrison = float

    ## cardinality = 0..1
    ### If yes, merge all the regiments in this province together into one army. Defaults to "no".
    merge = bool

    ## cardinality = 0..1
    can_toggle_looting = bool

    ## cardinality = 0..1
    is_looter = bool

    ## cardinality = 0..1
    ### If yes, the unit can reinforce. Defaults to "no".
    reinforces = bool

    ## cardinality = 0..1
    reinforce_rate_multiplier = float

    ## cardinality = 0..1
    maintenance = bool
}

## scope = character
### Starts a faction on the liege of the current character scope, if it does not already exist.
alias[effect:start_faction] = {
    faction = <objective.faction_character>

    ## cardinality = 0..1
    ### If yes, the character will join an already existing faction if there is one. Defaults to "no".
    can_join_existing = bool
}

## scope = character
### Starts a faction on the liege of the current character scope, if it does not already exist.
alias[effect:start_faction] = {
    faction = <objective.faction_liege_titles>

    title = scope[title]

    ## cardinality = 0..1
    ### If yes, the character will join an already existing faction if there is one. Defaults to "no".
    can_join_existing = bool
}

## scope = character
### Starts a faction on the liege of the current character scope, if it does not already exist.
alias[effect:start_faction] = {
    faction = <objective.faction_liege_titles_w_claimant>

    title = scope[title]

    thirdparty = scope[character]

    ## cardinality = 0..1
    ### If yes, the character will join an already existing faction if there is one. Defaults to "no".
    can_join_existing = bool
}

## scope = character
### Steal population from another nomad clan.
alias[effect:steal_population_scaled] = {
    target = scope[character]

    ### 0.0 is 0%, 1.0 is 100%
    percentage = float[0.001..1.0]
}

# TODO: Figure out
## scope = character
###
alias[effect:subjugate_or_take_under_title] = {
    title = scope[title]
    enemy = scope[character]
}

## scope = character
### Transfers all wealth from given character to scoped character.
alias[effect:transfer_scaled_wealth] = {
    from = scope[character]

    value = all

    ## cardinality = 0..1
    ### Minimum amount transferred
    min = float

    ## cardinality = 0..1
    ### Maximum amount transferred.
    max = float
}

# TODO: Scaled to from or to this?
## scope = character
### Transfers a scaled amount of wealth from given character to scoped character.
alias[effect:transfer_scaled_wealth] = {
    from = scope[character]

    ### 1.0 equals 1 year of income
    value = float[0.001..inf]

    ## cardinality = 0..1
    ### Minimum amount transferred
    min = float

    ## cardinality = 0..1
    ### Maximum amount transferred.
    max = float
}

## scope = character
### Transfers all wealth to given character from scoped character.
alias[effect:transfer_scaled_wealth] = {
    to = scope[character]

    value = all

    ## cardinality = 0..1
    ### Minimum amount transferred
    min = float

    ## cardinality = 0..1
    ### Maximum amount transferred.
    max = float
}

# TODO: Scaled to to or to this?
## scope = character
### Transfers all wealth to given character from scoped character.
alias[effect:transfer_scaled_wealth] = {
    to = scope[character]

    ### 1.0 equals 1 year of income
    value = float[0.001..inf]

    ## cardinality = 0..1
    ### Minimum amount transferred
    min = float

    ## cardinality = 0..1
    ### Maximum amount transferred.
    max = float
}

# TODO: Figure out
## scope = character
### Same as, wealth, ?
alias[effect:treasury] = int

## scope = character
### The scoped character gets impregnated by the given character. This will work even on someone already pregnant.
alias[effect:unsafe_impregnate] = scope[character]

## scope = character
### The scoped character gets impregnated. This will work even on someone already pregnant.
alias[effect:unsafe_impregnate] = 0

# TODO: Figure out
## scope = character
###
alias[effect:unsafe_impregnate_cuckoo] = scope[character]

# TODO: Figure out
## scope = character
###
alias[effect:unsafe_impregnate_cuckoo] = 0

# TODO update for thirdparty stuff when I do that
## scope = character
### Initiate a war; target is the defender, the scoped character is the attacker.
alias[effect:war] = {
    target = scope[character]
    casus_belli = <casus_belli>
    ## cardinality = 0..1
    thirdparty = scope[character]
    ## cardinality = 0..1
    ### Overrides the resulting threat value.
    infamy = int # TODO: is it really int?
}

# TODO: FIgure out
## scope = character
###
alias[effect:vassalize_or_take_under_title] = {
    title = scope[title]

    enemy = scope[character]
}

# TODO: FIgure out
## scope = character
###
alias[effect:vassalize_or_take_under_title_destroy_duchies] = {
    title = scope[title]

    enemy = scope[character]
}

# TODO update for thirdparty stuff when I do that
## scope = character
### Initiate a war; target is the defender, the scoped character is the attacker. Doesn't check if the casus belli can be used.
alias[effect:unsafe_war] = {
    target = scope[character]
    casus_belli = <casus_belli>
    ## cardinality = 0..1
    thirdparty = scope[character]
    ## cardinality = 0..1
    ### Overrides the resulting threat value.
    infamy = int # TODO: is it really int?
}

## scope = character
### Modify the wealth of the scoped character with the specified amount.
alias[effect:wealth] = float

# TODO: elaborate
## scope = character
### Modify the wealth of the scoped character with the wealth of the given character.
alias[effect:wealth] = scope[character]

# TODO: confirm scope
## scope = any
### Destroys the hospital in the specified province
alias[effect:destroy_hospital] = scope[province]

## scope = artifact
### Destroy the scoped artifact; PREV must be the owner. Cannot be used to destroy indestructible objects; see, unsafe_destroy_artifact.
alias[effect:destroy_artifact] = yes

# TODO: confirm if it's by type reference
## scope = character
### Destroy the artifact specified by name owned by the scoped character. If they own more than one, only the first one will be destroyed. Cannot be used to destroy indestructible objects; see, unsafe_destroy_artifact
alias[effect:destroy_artifact] = <artifact>

## scope = { character province }
### Converts scoped entity to the parent religion.
alias[effect:abandon_heresy] = yes

## scope = character
### Removes specified event id with a delayed trigger on scoped character.
alias[effect:clear_delayed_event] = {
    id = <event.character>
}

## scope = province
### Removes specified event id with a delayed trigger on scoped province.
alias[effect:clear_delayed_event] = {
    id = <event.province>
}

# TODO: confirm scopes, wiki's likely outdated here
## scope = character
### Clears all flags of the current scope that begin with the specified prefix.
alias[effect:clear_flags_with_prefix] = scalar

## scope = province
### Clears all flags of the current scope that begin with the specified prefix.
alias[effect:clear_flags_with_prefix] = scalar

## scope = { character province }
### Changes the scoped entity's culture to the given culture.
alias[effect:culture] = <culture>

## scope = { character province }
### Changes the scoped entity's culture to match the given character.
alias[effect:culture] = scope[character]

# TODO: check scopes
## scope = { character province }
### Adds a, religion modifier, to the religion of scoped entity.
alias[effect:religion_authority] = float

## scope = { character province }
### Adds the, religion modifier, to the religion of scoped entity with a given duration.
alias[effect:religion_authority] = {
    modifier = <religion_modifier>

    # TODO: see if other durations work
    ## cardinality = 0..1
    years = int
}

## scope = { character province }
### Change the given character's culture to match the scoped entity's.
alias[effect:reverse_culture] = scope[character]

## scope = { character province }
### Change the given title's culture to match the scoped entity's.
alias[effect:reverse_culture] = scope[title]

## scope = { character province }
### Change the given province's culture match to the scoped entity's.
alias[effect:reverse_culture] = scope[province]

# TODO: Probably a province RHS version exists?
## scope = { character province }
### Change the given character's religion to match the scoped entity's.
alias[effect:reverse_religion] = scope[character]

## scope = { character province }
### Change the given title's religion to match the scoped entity's.
alias[effect:reverse_religion] = scope[title]

## scope = character
### Lets the player rename the scoped character.
alias[effect:prompt_name] = {
    ### What player should get the prompt.
    player = scope[character]

    ### What message type to use, as defined in messagetypes.txt. This is what defines the text and picture. The text uses the current scopes.
    type = <message_type>

    ## cardinality = 0..1
    ### What portrait to show on the right. If not defined, the scoped character will be used.
    portrait = scope[character]

    ## cardinality = 0..1
    ### What name list to use. If not specified, the standard buttons for newborns will be used. The loc key should contain a list of names separated by pipes. Custom loc is supported, using the current scopes.
    name_list = localisation

    ## cardinality = 0..1
    ### Use the religion's name list.
    name_list = <religion>

    ## cardinality = 0..1
    ### Use the culture's name list.
    name_list = <culture>
}

## scope = province
### Lets the player rename the scoped province.
alias[effect:prompt_name] = {
    ### What player should get the prompt.
    player = scope[character]

    ### What message type to use, as defined in messagetypes.txt. This is what defines the text and picture. The text uses the current scopes.
    type = <message_type>

    ## cardinality = 0..1
    ### What portrait to show on the right.
    portrait = scope[character]

    ## cardinality = 0..1
    ### What name list to use. If not specified, there will be no "randomize name" button. The loc key should contain a list of names separated by pipes. Custom loc is supported, using the current scopes.
    name_list = localisation

    ## cardinality = 0..1
    ### Use the religion's name list.
    name_list = <religion>

    ## cardinality = 0..1
    ### Use the culture's name list.
    name_list = <culture>
}

## scope = title
### Lets the player rename the scoped title.
alias[effect:prompt_name] = {
    ### What player should get the prompt.
    player = scope[character]

    ### What message type to use, as defined in messagetypes.txt. This is what defines the text and picture. The text uses the current scopes.
    type = <message_type>

    ## cardinality = 0..1
    ### What portrait to show on the right.
    portrait = scope[character]

    ## cardinality = 0..1
    ### What name list to use. If not specified, there will be no "randomize name" button. The loc key should contain a list of names separated by pipes. Custom loc is supported, using the current scopes.
    name_list = localisation

    ## cardinality = 0..1
    ### Use the religion's name list.
    name_list = <religion>

    ## cardinality = 0..1
    ### Use the culture's name list.
    name_list = <culture>
}

## scope = artifact
### Lets the player rename the scoped artifact.
alias[effect:prompt_name] = {
    ### What player should get the prompt.
    player = scope[character]

    ### What message type to use, as defined in messagetypes.txt. This is what defines the text and picture. The text uses the current scopes.
    type = <message_type>

    ## cardinality = 0..1
    ### What portrait to show on the right.
    portrait = scope[character]

    ## cardinality = 0..1
    ### What name list to use. If not specified, there will be no "randomize name" button. The loc key should contain a list of names separated by pipes. Custom loc is supported, using the current scopes.
    name_list = localisation

    ## cardinality = 0..1
    ### Use the religion's name list.
    name_list = <religion>

    ## cardinality = 0..1
    ### Use the culture's name list.
    name_list = <culture>
}

## scope = bloodline
### Lets the player rename the scoped bloodline.
alias[effect:prompt_name] = {
    ### What player should get the prompt.
    player = scope[character]

    ### What message type to use, as defined in messagetypes.txt. This is what defines the text and picture. The text uses the current scopes.
    type = <message_type>

    ## cardinality = 0..1
    ### What portrait to show on the right.
    portrait = scope[character]

    ## cardinality = 0..1
    ### What name list to use. If not specified, there will be no "randomize name" button. The loc key should contain a list of names separated by pipes. Custom loc is supported, using the current scopes.
    name_list = localisation

    ## cardinality = 0..1
    ### Use the religion's name list.
    name_list = <religion>

    ## cardinality = 0..1
    ### Use the culture's name list.
    name_list = <culture>
}

# TODO: Confirm if scope references to titles still don't work
## scope = character
### Adds a weak, non-inheritable claim on given title to the scoped character.
alias[effect:add_weak_claim] = <title>

## scope = title
### Adds a weak, non-inheritable claim on scoped title to the given character.
alias[effect:add_weak_claim] = scope[character]

# TODO: Confirm if scope references to titles still don't work
## scope = character
### Adds a weak, inheritable claim on given title to the scoped character.
alias[effect:add_weak_pressed_claim] = <title>

## scope = title
### Adds a weak, inheritable claim on scoped title to the given character.
alias[effect:add_weak_pressed_claim] = scope[character]

# TODO: Elaborate; confirm scope
## scope = { character title }
### approve_law = law, starts a vote on a law
alias[effect:approve_law] = <law>

# TODO: Figure out
## scope = { character title }
###
alias[effect:approve_law] = scope[title]

# TODO: Figure out
## scope = { character title }
### ???
alias[effect:conquest_culture] = scope[culture]

# TODO: Figure out
## scope = { character title }
### ???
alias[effect:conquest_culture] = scope[character]

# TODO confirm scope
## scope = character
### Creates a hospital in the specified province
alias[effect:create_hospital] = scope[province]

# TODO confirm scope
## scope = character
### Creates a trade post in the specified province (only works if the character meets requirements such as being under their trade post limit)
alias[effect:create_tradepost] = scope[province]

# TODO: Confirm scopes
## scope = { character title }
### Grants an amount of prestige to the scoped character (title?).
alias[effect:prestige] = int

## scope = { character province title }
### Changes the public religion of the scoped entity to match the given entity's public religion. See also, unsafe_religion.
alias[effect:religion] = scope[religion]

## scope = { character province title }
### Changes the public religion of the scoped entity to match the given character's public religion. See also, unsafe_religion.
alias[effect:religion] = scope[character]

## scope = { character province title }
### Changes the public religion of the scoped entity to match the given religion.
alias[effect:religion] = <religion>

## scope = character
### Changes the public religion of the scoped entity. The target_type parameter specifies which of the given target's religion to use. See also, unsafe_religion.
alias[effect:religion] = {
    target = scope[religion]
    target_type = enum[religion_visibility]
}

# TODO: Confirm if scope references to titles still don't work
## scope = character
### Removes the scoped character's claim on the given title.
alias[effect:remove_claim] = <title>

## scope = title
### Removes the given character's claim on the scoped title.
alias[effect:remove_claim] = scope[character]

## scope = character
### Removes the given claim on the scoped character.
alias[effect:remove_claim] = scope[title]

# TODO update for thirdparty stuff when I do that
## scope = character
### Initiate a war; target is the attacker, the scoped character is the defender.
alias[effect:reverse_war] = {
    target = scope[character]
    casus_belli = <casus_belli>
    ## cardinality = 0..1
    thirdparty = scope[character]
    ## cardinality = 0..1
    ### Overrides the resulting threat value.
    infamy = int # TODO: is it really int?
}

# TODO: Confirm scopes
## scope = { character title }
### Makes the scoped character independent.
alias[effect:set_defacto_liege] = THIS

# TODO: Confirm scopes
## scope = { character title }
### Sets the liege of the scoped character to the given character.
alias[effect:set_defacto_liege] = scope[character]

# TODO: Confirm scopes
## scope = { character title }
### Sets the liege of the scoped character to the holder of the given title.
alias[effect:set_defacto_liege] = scope[title]

# TODO: Confirm scopes
## scope = { character title province artifact bloodline }
### Override the name of the scoped entity.
alias[effect:set_name] = scalar

# TODO: Confirm scopes
## scope = { character title province artifact bloodline }
### Resets the name of the scoped entity to the original name.
alias[effect:set_name] = ""

## scope = character
### Changes the name of the scoped character to the given character's.
alias[effect:set_name] = scope[character]

## scope = title
### Changes the name of the scoped title to the given title's.
alias[effect:set_name] = scope[title]

## scope = province
### Changes the name of the scoped province to the given province's.
alias[effect:set_name] = scope[province]

## scope = artifact
### Changes the name of the scoped artifact to the given artifact's.
alias[effect:set_name] = scope[artifact]

## scope = bloodline
### Changes the name of the scoped bloodline to the given bloodline's.
alias[effect:set_name] = scope[bloodline]

# TODO: See if the clause version works
## scope = { character province title }
### Changes the public religion of the scoped entity to match the given entity's public religion. Bypasses some error-checking in set religion, allowing to change the religion of the leader of a holy order, a religious head or a rebel leader. Use with care!
alias[effect:unsafe_religion] = scope[religion]

# TODO: See if the clause version works
## scope = { character province title }
### Changes the public religion of the scoped entity to match the given religion. Bypasses some error-checking in set religion, allowing to change the religion of the leader of a holy order, a religious head or a rebel leader. Use with care!
alias[effect:unsafe_religion] = <religion>

## scope = { character province title }
### Creates a quest targeting the scoped entity or changes the target of an already existing quest to the scoped entity.
alias[effect:set_quest_target] = {
    id = value_set[quest]

    ### The questor.
    holder = scope[character]

    ## cardinality = 0..1
    ### Defaults to the character's society. If the society is not set, and the character is not part of a society, this will send an error and nothing will happen.
    society = scope[society]
}

## scope = character
### Changes the name of the scoped character to the given character's. Redundant with set_name.
alias[effect:copy_name] = scope[character]

## scope = title
### Changes the name of the scoped title to the given title's. Redundant with set_name.
alias[effect:copy_name] = scope[title]

## scope = province
### Changes the name of the scoped province to the given province's. Redundant with set_name.
alias[effect:copy_name] = scope[province]

## scope = artifact
### Changes the name of the scoped artifact to the given artifact's. Redundant with set_name.
alias[effect:copy_name] = scope[artifact]

## scope = bloodline
### Changes the name of the scoped bloodline to the given bloodline's. Redundant with set_name.
alias[effect:copy_name] = scope[bloodline]

## scope = chararcter
### Clears a flag previously set in the scoped character's dynasty.
alias[effect:clr_dynasty_flag] = value[dynasty_flag]

## scope = title
### Adds a modifier to the scoped title, if it's a holding.
alias[effect:add_holding_modifier] = {
    modifier = <event_modifier>
    ## cardinality = 0..1
    hidden = yes
    ## cardinality = 0..1
    stacking = yes
    enum[duration_dmy] = int
}

## scope = title
### Makes the scoped holding the capital of the province. Also see, revoke_capital_holding.
alias[effect:make_capital_holding] = yes

# TODO: Confirm
## scope = title
### Reverts the scoped holding's province's capital to default? Also see, make_capital_holding.
alias[effect:revoke_capital_holding] = yes

# TODO: Confirm scope and confirm value variable type (maybe float?).
## scope = any
### Changes the amount of wealth brought from off-map; same as the "wealth" parameter in the trade route definition, except can be done dynamically.
alias[effect:set_trade_route_base_value] = {
    which = <trade_route>

    value = int
    value = value[variable]
}

## scope = any
### Multiplies the value of the trade route. If set to 0, the province tooltip will explain that the route is inactive.
alias[effect:set_trade_route_value_multiplier] = {
    which = <trade_route>

    value = float
}

## scope = offmap
### Clears the given temporary flag from the scoped offmap power.
alias[effect:clr_offmap_tmp_flag] = value[offmap_tmp_flag]

## scope = offmap
### Sets the scoped offmap power's current ruler to the target scope, automatically killing the previous ruler.
alias[effect:set_offmap_holder] = scope[character]

## scope = offmap
### Sets the scoped offmap power's name to the given localisation key.
alias[effect:set_offmap_name] = localisation

## scope = offmap
### Adds the given temporary flag to the scoped offmap power.
alias[effect:set_offmap_tmp_flag] = value_set[offmap_tmp_flag]

## scope = offmap
### Sets the scoped offmap power's current policy to the given one.
alias[effect:set_policy] = <offmap_policy>

## scope = offmap
### Sets the scoped offmap power's current status modifier to the given one.
alias[effect:set_status] = <offmap_status>

## scope = province
### Adds or removes [value] holdings slots to or from the scoped province.
alias[effect:add_holding_slot] = int

## scope = province
### Adds a, province modifier to the scoped province.
alias[effect:add_province_modifier] = {
    enum[modifier_names] = <event_modifier>
    enum[modifier_names] = <static_modifier>
    ## cardinality = 0..1
    hidden = yes
    ## cardinality = 0..1
    stacking = yes
    enum[duration_dmy] = int
}

## scope = province
### Construct a building in a special holding in the scoped province.
alias[effect:add_to_extra_holding] = {
    type = enum[holding_types_special]
    building = <building>
}

# TODO: Maybe slightly more docs.
## scope = province
### Builds a new barony-tier holding in the scoped province; adds holding slots if necessary.
alias[effect:build_holding] = {
    ## cardinality = 0..1
    title = <title.barony>
    type = enum[holding_types_barony_only]
    ## cardinality = 0..1
    holder = scope[character]
}

# TODO: wtf is this it doesn't show up anywhere
## scope = province
###
alias[effect:change_random_civ_tech] = int

# TODO: wtf is this it doesn't show up anywhere
## scope = province
###
alias[effect:change_random_eco_tech] = int

# TODO: wtf is this it doesn't show up anywhere
## scope = province
###
alias[effect:change_random_mil_tech] = int

## scope = province
### Improves technology in the scoped province.
alias[effect:change_tech] = {
    technology = <technology>
    value = int
}

# TODO: Elaborate
## scope = province
###
alias[effect:clear_revolt] = yes

## scope = province
### Clears a previously set flag in the scoped province.
alias[effect:clr_province_flag] = value[province_flag]

## scope = province
### Destroy the fort in the scoped province.
alias[effect:destroy_fort] = yes

## scope = province
### Destroy a building in a special holding in the scoped province.
alias[effect:destroy_in_extra_holding] = {
    type = enum[holding_types_special]
    building = <building>
}

# TODO: FIgure out what durations can be used
## scope = province
### Fires an event for the scoped province.
alias[effect:province_event] = {
    id = <event.province>

    ## cardinality = 0..1
    days = int

    ## cardinality = 0..1
    ### Number of days to add randomly for the event occurrence date, closed-ended (days to days+random).
    random = int

    # TODO: Figure out default
    ## cardinality = 0..1
    ### Tooltip for the effect. If not specified, ???
    tooltip = localisation
}

# TODO: Figure out
## scope = province
###
alias[effect:reduce_disease] = float

# TODO: Add province modifier only
## scope = province
### Removes a, province modifier from the scoped province.
alias[effect:remove_province_modifier] = <event_modifier>

## scope = province
### Removes a number of instances of a, province modifier from the scoped province.
alias[effect:remove_province_modifiers] = {
    modifier = <event_modifier>
    amount = int[1..inf]
}

## scope = province
### Sets a flag in the scoped province.
alias[effect:set_province_flag] = value_set[province_flag]

## scope = province
### Spawns a specific disease in the scoped province.
alias[effect:spawn_disease] = <disease>

# TODO: Figure out
## scope = province
###
alias[effect:steal_random_tech] = scope[character]

# TODO: Confirm
## scope = { province title }
### Destroys a random building in the scoped holding or the scoped province's capital (?).
alias[effect:destroy_random_building] = yes

# TODO: Confirm
## scope = { province title }
### Destroys a random building in the scoped holding or the scoped province's capital (?); the given building will never be picked for destruction, even if it is the only one left.
alias[effect:destroy_random_building] = <building>

## scope = religion
### Adds an evil god name to the scoped religion.
alias[effect:add_evil_god_name] = localisation

## scope = religion
### Adds a god name to the scoped religion.
alias[effect:add_god_name] = localisation

## scope = religion
### Removes all evil god names from the scoped religion.
alias[effect:remove_evil_god_names] = yes

## scope = religion
### Removes all god names from the scoped religion.
alias[effect:remove_god_names] = yes

## scope = religion
### Sets the scoped religion's high god's name to the given key.
alias[effect:set_high_god_name] = localisation

## scope = religion
### Sets the scoped religion's, men_can_take_consorts, attribute to the given value.
alias[effect:set_men_can_take_consorts] = bool

## scope = religion
### Sets the scoped religion's, rel_head_defense, attribute to the given value.
alias[effect:set_rel_head_defense] = bool

## scope = religion
### Sets the scoped religion's, women_can_take_consorts, attribute to the given value.
alias[effect:set_women_can_take_consorts] = bool

## scope = society
### Adds a given value to the scoped society's current progress.
alias[effect:add_society_progress] = float

## scope = society
### Sets the scoped society's current progress to a given value.
alias[effect:set_society_progress] = float

## scope = society
### Enables the scoped society's progress bar.
alias[effect:start_society_progress] = yes

## scope = society
### Disables the scoped society's progress bar.
alias[effect:stop_society_progress] = yes

## scope = title
### Constructs a building in the scoped holding. Also constructs the buildings it upgrades from, based on upgrades_from.
alias[effect:add_building] = <building>

# TODO: Confirm if it's ignored in this case
## scope = title
### Sets the specified law for the scoped title, ignoring cooldown and opinion effects.
alias[effect:add_law] = <law>

## scope = title
### Sets the specified law for the scoped title with some extra parameters.
alias[effect:add_law] = {
    law = <law>

    ## cardinality = 0..1
    ### If yes, cooldown is ignored when executing this command. Defaults to "yes".
    cooldown = bool

    ## cardinality = 0..1
    ### If yes, opinion effects on vassals are ignored when executing this command. Defaults to "yes".
    opinion_effect = bool
}

# TODO: Figure out
## scope = title
###
alias[effect:add_law_w_cooldown] = <law>

# TODO: Confirm
## scope = title
### Sets the scoped title's adjective to the given string.
alias[effect:adjective] = scalar

# TODO: Is it really dynamic only?
## scope = title
### Update the percentage of income that goes to the creator for the scoped dynamic mercenary company.
alias[effect:adjust_siphon_factor] = float

# TODO: Is it really dynamic only? Also, figure out and confirm it's any troop types and not land only
## scope = title
### Change the composition of the scoped dynamic mercenary title.
alias[effect:change_mercenary_composition] = {
    ## cardinality = 0..1
    from = enum[troop_types]
    type = enum[troop_types]
    change = int
}

## scope = title
### Changes the army size of the scoped mercenary/adventurer title.
alias[effect:change_title_army_size] = float

# TODO: Figure out, check durations
## scope = title
###
alias[effect:clan_opinion] = {
    who = scope[title]
    modifier = <opinion_modifer>
    years = int
}

# TODO: Figure out, check durations
## scope = title
###
alias[effect:clan_reverse_opinion] = {
    who = scope[title]
    modifier = <opinion_modifer>
    years = int
}

## scope = title
### Clears a previously set flag from the scoped title.
alias[effect:clr_title_flag] = value[title_flag]

## scope = title
### Copies title history from the given title to the scoped title.
alias[effect:copy_title_history] = scope[title]

## scope = title
### Copies title laws from the given title to the scoped title.
alias[effect:copy_title_laws] = scope[title]

## scope = title
### Create a feud between two clans, the given and the scoped title.
alias[effect:create_feud] = scope[title]

# TODO: Is it really dynamic only?
## scope = title
### Break the scoped dynamic mercenary title free from its creator.
alias[effect:cut_mercenary_creator_relation] = yes

# TODO: Elaborate
## scope = title
### Changes the de jure structure.
alias[effect:de_jure_liege] = scope[character]

# TODO: Elaborate
## scope = title
### Changes the de jure structure.
alias[effect:de_jure_liege] = scope[title]

# TODO: Elaborate
## scope = title
### Changes the de jure structure.
alias[effect:de_jure_liege] = 0

## scope = any
### Destroys the given landed title. It can later be re-created by the player or AI, unlike when deactivated via activate_title.
alias[effect:destroy_landed_title] = scope[title]

## scope = any
### Destroys the given holding. Also see, build_holding.
alias[effect:destroy_settlement] = scope[title]

## scope = title
### Destroys the scoped holding. Also see, build_holding.
alias[effect:destroy_settlement] = yes

# TODO: RHS value? Probably enum
## scope = title
### Changes council laws. Also see, enable_council_voting_on_issue.
alias[effect:disable_council_voting_on_issue] = scalar

# TODO: RHS value? Probably enum
## scope = title
### Changes council laws. Also see, disable_council_voting_on_issue.
alias[effect:enable_council_voting_on_issue] = scalar

# TODO: Elaborate
## scope = title
### Ends a blood oath.
alias[effect:end_oath] = scope[title]

# TODO: Elaborate
## scope = title
### Similar to abdicate_to
alias[effect:gain_title] = scope[character]

# TODO: Elaborate
## scope = title
### Similar to abdicate_to
alias[effect:gain_title] = scope[title]

# TODO: Figure out
## scope = title
### ???
alias[effect:gain_title_plus_barony_if_unlanded] = scope[character]

# TODO: Figure out
## scope = title
###
alias[effect:gender_succ] = enum[gender_successions]

# TODO: Figure out
## scope = title
###
alias[effect:grant_kingdom_w_adjudication] = scope[character]

# TODO: Figure out
## scope = title
###
alias[effect:make_primary_title] = yes

# TODO: Figure out
## scope = title
###
alias[effect:press_claim] = scope[character]

# TODO: Elaborate
## scope = title
###
alias[effect:province_capital] = yes

# TODO: Figure out
## scope = title
###
alias[effect:rebel_defection] = yes

# TODO: Figure out
## scope = title
###
alias[effect:refill_holding_levy] = yes

# TODO: Figure out
## scope = title
###
alias[effect:remove_building] = <building>

## scope = title
### Removes a holding modifier from the scoped holding.
alias[effect:remove_holding_modifier] = <event_modifier>

## scope = title
### Removes a number of instances of a, holding modifier from the scoped holding.
alias[effect:remove_holding_modifiers] = {
    modifier = <event_modifier>
    amount = int[1..inf]
}

# TODO: I think mordzuber over at discord found out some stuff about it.
## scope = title
### Removes the scoped county from being a holy site of the given religion. Warning: this lets you have less than 5 holy sites which might cause weirdness. Also, removing holy sites to a religion but not its heresies will cause their icons to show up individually on other shared holy sites instead of being hidden like normal.
alias[effect:remove_holy_site] = scope[religion]

# TODO: I think mordzuber over at discord found out some stuff about it.
## scope = title
### Removes the scoped county from being a holy site of the given religion and its heresies. Warning: this lets you have less than 5 holy sites which might cause weirdness.
alias[effect:remove_holy_site_with_heresies] = scope[religion]

# TODO: Figure out
## scope = any
###
alias[effect:reset_coa] = scope[title]

# TODO: Figure out
## scope = title
###
alias[effect:revoke_law] = <law>

# TODO: Figure out
## scope = title
###
alias[effect:set_allow_feminism] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_free_duchy_revokation] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_free_infidel_revokation] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_free_revokation] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_free_vice_royalty_revokation] = bool

# TODO: Figure out
## scope = title
###
alias[effect:set_allow_gender_laws] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_title_revokation] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_vice_royalties] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_allow_vice_royalties] = enum[title_tiers]

# TODO: Figure out
## scope = title
###
alias[effect:set_allows_matrilineal_marriage] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_appoint_generals] = bool

# TODO: Figure out
## scope = title
### Crown laws
alias[effect:set_appoint_regents] = bool

## scope = title
### Set the coats of arms of the scoped title to that of the given title.
alias[effect:set_coa] = scope[title]

# TODO: I think mordzuber over at discord found out some stuff about it.
## scope = title
### Sets the scoped county to be a holy site of the given religion. Warning: this lets you have more than 5 holy sites which might cause weirdness. Also, adding holy sites to a religion but not its heresies will cause their icons to show up individually on other shared holy sites instead of being hidden like normal.
alias[effect:set_holy_site] = scope[religion]

# TODO: I think mordzuber over at discord found out some stuff about it.
## scope = title
### Sets the scoped county to be a holy site of the given religion and its heresies. Warning: this lets you have more than 5 holy sites which might cause weirdness.
alias[effect:set_holy_site_with_heresies] = scope[religion]

# TODO: Docs
## scope = title
###
alias[effect:set_investiture] = enum[investiture_types]

# TODO: Figure out
## scope = title
###
alias[effect:set_mercenary_maintenance_modifier] = <static_modifier>

## scope = title
### The scoped title becomes under the authority of the specified Pentarch seat.
alias[effect:set_pentarch_title] = scope[title]

## scope = title
### The scoped title stops being under the authority of the Pentarchy.
alias[effect:set_pentarch_title] = none

## scope = title
### Sets the preferred capital of the scoped title to the given province.
alias[effect:set_preferred_capital] = scoped[province]

# TODO: reword
## scope = title
### Crown laws: avoid titles leaving the realm upon inheritance
alias[effect:set_protected_inheritance] = bool

## scope = title
### Sets the title's, short_name, parameter to the given value.
alias[effect:set_short_name] = bool

# TODO: reword
## scope = title
### Crown laws: allow/disallow vassals to wage war.
alias[effect:set_the_kings_full_peace] = bool

# TODO: reword
## scope = title
### Crown laws: allow/disallow vassals to wage war between them.
alias[effect:set_the_kings_peace] = bool

# TODO: reword
## scope = title
### set/unset title as being an adventurer title.
alias[effect:set_title_adventurer] = clause

## scope = title
### Sets a, flag, in the scoped title.
alias[effect:set_title_flag] = value_set[title_flag]

# TODO: reword
## scope = title
### set/unset title as being a temporary title.
alias[effect:set_title_landless] = clause

# TODO: reword
## scope = title
### set/unset title as being a nomad title.
alias[effect:set_title_nomad] = clause

# TODO: reword
## scope = title
### Whether liege can directly raise tribal vassal levies
alias[effect:set_tribal_vassal_levy_control] = bool

# TODO: reword
## scope = title
### Whether tribal vassals pay taxes to their liege
alias[effect:set_tribal_vassal_tax_income] = bool

# TODO: Confirm if that hasn't changed with the introduction of moddable successions. Make an enum in either case
## scope = title
### Valid successions: gavelkind, primogeniture, feudal_elective, seniority, catholic_bishopric, open_elective, turkish_succession, patrician_elective, ultimogeniture, tanistry, appointment, papal_succession, elective_gavelkind
alias[effect:succession] = <law.succession>

# TODO: Figure out
## scope = title
###
alias[effect:succession_w_cooldown] = <law.succession>

## scope = title
### Converts the scoped barony-tier holding to another type.
alias[effect:convert_to] = enum[holding_types_barony_only]

# TODO: Confirm if scope references to titles still don't work
## scope = character
### Adds a strong, non-inheritable claim on given title to the scoped character.
alias[effect:add_claim] = <title>

## scope = title
### Adds a strong, non-inheritable claim on scoped title to the given character.
alias[effect:add_claim] = scope[character]

# TODO: Confirm if scope references to titles still don't work
## scope = character
### Adds a strong, inheritable claim on given title to the scoped character.
alias[effect:add_pressed_claim] = <title>

## scope = title
### Adds a strong, inheritable claim on scoped title to the given character.
alias[effect:add_pressed_claim] = scope[character]

# TODO: Figure out
## scope = { title province }
###
alias[effect:seize_trade_post] = scope[character]

## scope = unit
### Creates casualties for an army (whole unit or a specific unit type) by a fixed amount. They won't be displayed in a combat report. Using a negative number will heal units instead.
alias[effect:damage_unit] = {
    amount = int
    ## cardinality = 0..1
    ### Which type to affect.
    type = enum[troop_types]
}

## scope = unit
### Creates casualties for an army (whole unit or a specific unit type) by a percentage. They won't be displayed in a combat report. Using a negative number will heal units instead.
alias[effect:damage_unit] = {
    percentage = float
    ## cardinality = 0..1
    ### Which type to affect.
    type = enum[troop_types]
}

# TODO: Confirm if it "Only takes absolute values." or variables are ok
## scope = unit
### Removes morale for the army (or adds morale with negative values).
alias[effect:damage_unit_morale] = float

# TODO: Write doc
## scope = unit
###
alias[effect:set_can_toggle_looting] = bool

# TODO: Reword and write doc
## scope = unit
### Used with, set_can_toggle_looting
alias[effect:set_looting] = bool

## scope = { unit siege }
### Changes the morale of the unit by the amount indicated
alias[effect:morale] = float

## scope = { unit siege }
### Changes the size of the unit by the amount indicated
alias[effect:troops] = float

# TODO: Enum it up
## scope = war
### Possible war ends: invalid, whitepeace, success, reverse_demand
alias[effect:end_war] = enum[war_ends]

alias[effect:custom_tooltip] = {
    text = localisation
    alias_name[effect] = alias_match_left[effect]

}

# TODO: Might be covered by scope_field
alias[effect:hidden_tooltip] = {
    alias_name[effect] = alias_match_left[effect]
}

# TODO: Docs?
alias[effect:conditional_tooltip] = {
    trigger = single_alias_right[trigger_clause]
    alias_name[trigger] = alias_match_left[trigger]
}

### This acts as a return statement, causing everything after it (in the main block: option, immediate, ...) to be ignored
alias[effect:break] = yes

alias[effect:show_scope_change] = no
alias[effect:generate_tooltip] = no

# TODO: Doc
alias[effect:tooltip] = {
    alias_name[effect] = alias_match_left[effect]
}

# TODO: Doc
alias[effect:set_looter_hostility_days] = {
    who = scope[character]
    days = int
}

# TODO: Doc
alias[effect:transfer_scaled_wealth] = {
    to = scope[character]
    value = float
}

# TODO: Docs
## scope = character
###
alias[effect:prisoner] = scope[character]

# TODO: Docs
## scope = Character
###
alias[effect:prisoner] = bool

# TODO: Docs and check scope
## scope = wonder
###
alias[effect:set_wonder_damaged] = bool

# TODO: Docs and check scope
## scope = province
###
alias[effect:add_wonder] = <wonder>

# TODO: Docs and check scope
## scope = province
###
alias[effect:destroy_wonder] = bool

# TODO: Docs and check scope
## scope = province
###
alias[effect:set_wonder_model] = <model>

# Works in religion scope, or a scope from which a religion can be gotten (character, province, county/barony title, title with religion defined, society with associated religion):
# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_peace_piety_gain] = int

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_pacifist] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_convert_other_groups] = int

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_convert_same_group] = int

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_peace_prestige_loss] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_ai_aggression] = float

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_unit_modifier] = {
    alias_name[modifier] = alias_match_left[modifier]
}

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_unit_home_modifier] = {
    alias_name[modifier] = alias_match_left[modifier]
}

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_hard_to_convert] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_raised_vassal_opinion_loss] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_piety_loss_for_attacking_same_religion] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_max_wives] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_max_consorts] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_feminist] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_heir_designation] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_short_reign_opinion_year_mult] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_jizya_tax] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_retire_to_monastery] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_excommunicate] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_grant_divorce] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_grant_invasion_cb] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_grant_claim] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_call_crusade] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_pc_marriage] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_bs_marriage] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_psc_marriage] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_cousin_marriage] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_seafaring] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_allow_looting] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_allow_rivermovement] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_autocephaly] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_pentarchy] = bool

# When used in religion scope, sets the title that controls the religion. Use "none" to set the religion as not having any controller. If a title already controls the religion when this is called, it will cease to control the religion. Example: set_religion_head = k_norway/ROOT/none
# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_religion_head] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_uses_decadence] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_can_have_antipopes] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_priests_can_marry] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_priests_can_inherit] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_ignores_defensive_attrition] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_character_modifier] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:add_intermarry] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:remove_intermarry] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:clear_intermarry] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_defensive_attrition] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_female_temple_holders] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_male_temple_holders] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_branch_tag] = bool

# TODO: Docs and fix title with religion defined and society with associated religion
## scope = { religion character province title society }
###
alias[effect:set_allows_matrilineal_marriage] = bool