The Muse - User contributions [en]

Events and Context

2026-07-27T17:49:48Z

GavstarB: formatting

== The Events System ==
Lancer is a system famous for its numerous reactions and counter-reactions. In Lancer Tactics, this is handled by generating EventCore objects and then queueing them to each other in one big stack. EventCores each have an EventBase resource in their <code>base</code> variable, which defines the type of event it is. The EventCore object is typically called <code>activation</code>, <code>event</code> or <code>core</code>.

Olive's [https://wick.works/devlog/event-system-aka-how-to-handle-nested-youve-activated-my-trap-card-triggers devlog] on the subject (which you should check out just for the meme).

===== Execution Sequence =====
* Run the <code>execute_preblock()</code> function for the event's EventBase:
<blockquote>• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.

• The reaction events are ordered according to their priority (low to high).

• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.
* Run the <code>execute()</code> function for the event's EventBase:
<blockquote>• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).

• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.POST</code>.

• The reaction events are ordered according to their priority (low to high).

• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* Run child events:
<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.

• The child events are ordered according to their priority (low to high).

• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>
== Context ==
Data is passed between events within a Context object, which contains any parameters an event needs in order to execute. The Context is checked by an event immediately before calling its <code>execute()</code> function to see if it is able to run. Reactions with <code>ReactionBus.TIMING. PRE</code> can modify the Context of the event they are reacting to before the event itself occurs, which allows them to change the event's behavior.

Whether the Context object contains a specific variable can be queried using the <code>context.is_property_present()</code> function.

The Context objects contains the following variables:
{| class="wikitable mw-collapsible"
!Variable
!Type
!Additional Info
|-
|<code>action</code>
|Action
|See Actions and Reactions.
|-
|<code>array</code>
|Array
|
|-
|<code>boolean</code>
|bool
|
|-
|<code>buff</code>
|BuffCore
|
|-
|<code>category</code>
|Variant
|Represents an enum or id string.
|-
|<code>category_int</code>
|int
|The <code>category</code> variable, typed as an int. Setting this will modify the <code>category</code> variable.
|-
|<code>category_string</code>
|StringName
|The <code>category</code> variable, typed as a StringName. Setting this will modify the <code>category</code> variable.
|-
|<code>event</code>
|EventCore
|Usually the parent event of the current event.
|-
|<code>flags</code>
|Array
|Usually contains enums.
|-
|<code>gear</code>
|GearCore
|
|-
|<code>map</code>
|MapState
|Always populated.
|-
|<code>number</code>
|int
|
|-
|<code>object</code>
|Variant
|
|-
|<code>resource</code>
|Resource
|
|-
|<code>string</code>
|String
|
|-
|<code>target_tiles</code>
|Array[Vector2i]
|
|-
|<code>target_tile</code>
|Vector2i
|<code>target_tiles[0]</code>, or <code>Tile.INVALID</code> if it is empty. Setting this will add the Vector2i to <code>target_tiles</code> at index 0.
|-
|<code>target_units</code>
|Array[Unit]
|
|-
|<code>target_unit</code>
|Unit
|<code>target_units[0]</code>, or <code>null</code> if it is empty. Setting this will add the Unit to <code>target_units</code> at index 0.
|-
|<code>unit</code>
|Unit
|
|}

== Event Creation ==
A Context object is usually created from a dictionary, where each key corresponds to the name of a variable:
var context = Context.create({
string = "Example Context",
boolean = true
})
Events are almost always created using the functions on their parent event, although it is possible to create one directly to make a virtual event not queued to any other event.

An event can be queued to the <code>activation</code> event with:
activation.queue_event(&"event_example_id", {
string = "Example Event",
boolean = true
}, Priority.ACTIVATE.late_followup)
Events can also be executed immediately:
await activation.execute_event(&"event_example_id", {
string = "Example Event",
boolean = true
})
'''<big>As with any other <code>await</code> function, check your references are not <code>null</code> before proceeding.</big>'''

== Event Types ==
The scripts defining the game's events can be found in the <code>res://content/events/</code> folder.

===== Events with Reactions =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
!Reactions
|-
|<code>event_combat_end</code>
|<code>boolean</code> - victory?
|
|<code>combat_end</code>
|-
|<code>event_combat_set_state</code>
|<code>string</code>
<code>object</code>
|
|<code>modified_combat_state</code>
|-
|<code>event_combat_start</code>
|
|
|<code>combat_start</code>
|-
|<code>event_combat_trigger_signal</code>
|<code>string</code>
|<code>number</code>
<code>boolean</code>

<code>unit</code>

<code>object</code>

<code>array</code> - if given, emits the signal more than once for each item in the array
|<code>trigger_signal</code>
|-
|<code>event_gear_activate</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>
|<code>target_tiles</code> - targeting hint
<code>target_units</code> - targeting hint

<code>event</code> - parent event during reactions

<code>flags</code> - Action.FLAG

<code>object</code> - Pathfinder if can move before taking action

<code>string</code> - id of variant Action to be used
|<code>unit_action</code> - generates a fake Context matching that of <code>event_unit_action</code>. Context cannot be modified by <code>PRE</code> events
<code>stabilize</code>
|-
|<code>event_gear_destroy</code>
|<code>unit</code>
<code>gear</code>
|
|<code>gear_destruction</code>
|-
|<code>event_gear_reload</code>
|<code>unit</code>
(<code>gear</code>

'''and/or'''

<code>array</code> - Array[GearCore])
|
|<code>reload</code>
|-
|<code>event_map_damage</code>
|<code>target_tiles</code>
<code>number</code>
|<code>flags</code> - EventMapDamage.FLAG
<code>object</code> - elevation to destroy down to (int)

<code>boolean</code> - set to true if terrain got destroyed
|<code>terrain_damage</code>
|-
|<code>event_round_new</code>
|
|
|<code>new_round</code>
|-
|<code>event_turn_end</code>
|<code>unit</code>
|
|<code>end_turn</code>
|-
|<code>event_turn_start</code>
|<code>unit</code>
|
|<code>new_turn</code>
|-
|<code>event_unit_action</code>
|<code>unit</code>
<code>string</code> - kit id

<code>number</code> - action index
|<code>target_tiles</code>
<code>target_units</code>

<code>flags</code> - Action.FLAG

<code>gear</code>

<code>action</code>
|executes an <code>event_gear_activate</code> which in turn runs <code>unit_action</code> reactions with a context matching this event
|-
|<code>event_unit_apply_status</code>
|<code>unit</code>
<code>category</code>

<code>flags</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>PRE</code>)
|-
|<code>event_unit_attack</code>
|<code>target_unit</code> - attacked unit
<code>unit</code> - attacking unit

<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary

<code>event</code> - <code>event_unit_attack_declared</code>
|<code>flags</code> - Action.FLAG
|<code>attack</code>
|-
|<code>event_unit_attack_declared</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary
|
|<code>attack_declared</code>
|-
|<code>event_unit_boost</code>
|<code>unit</code>
|<code>event</code>
|<code>boost</code>
|-
|<code>event_unit_brace</code>
|<code>unit</code>
|
|<code>brace</code>
|-
|<code>event_unit_clear_status</code>
|<code>unit</code>
<code>category</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>POST</code>)
|-
|<code>event_unit_collide</code>
|<code>unit</code>
<code>target_tiles</code> - tile collided with

<code>event</code>
|
|<code>collision</code>
|-
|<code>event_unit_cool</code>
|<code>unit</code>
<code>number</code>
|
|<code>clear_heat</code>
|-
|<code>event_unit_damage</code>
|<code>unit</code>
<code>number</code>
|<code>category</code> - Lancer.DAMAGE_TYPE - default kinetic
<code>object</code> - AttackRoll

<code>flags</code> - EventService.DAMAGE_FLAG

<code>target_unit</code> - attacker

<code>gear</code> - attacker gear

<code>action</code> - attacker Action
|<code>damage</code>
|-
|<code>event_unit_die</code>
|<code>unit</code>
|<code>flags</code> - EventService.DIE_FLAG
|<code>death</code>
|-
|<code>event_unit_exile</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>exiled</code>
|-
|<code>event_unit_intangible</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>intangible</code>
|-
|<code>event_unit_lose_hidden</code>
|<code>unit</code>
|
|<code>lose_hidden</code>
|-
|<code>event_unit_meltdown</code>
|<code>unit</code>
|
|<code>meltdown</code>
|-
|<code>event_unit_move</code>
|<code>unit</code>
(<code>target_tiles</code> - path or single tile to path to. in <code>PRE</code> reactions to <code>step</code>, holds the tile the unit is about to step into

'''or'''

<code>array</code> - Array[Pathfinder.Step] - final path)
|<code>resource</code> - MovementType
<code>flags</code> - EventUnitMove.FLAG

<code>object</code> - SpecificAction which caused the move
|<code>step</code>
<code>entire_movement</code>
|-
|<code>event_unit_save</code>
|<code>target_unit</code>
<code>category</code> - Lancer.HASE
|<code>unit</code> - origin unit
<code>gear</code> - origin gear

<code>action</code> - origin action

<code>string</code> - combat state key for success boolean to be saved to
|<code>forced_save</code>
|-
|<code>event_unit_spawn</code>
|<code>unit</code>
<code>target_tiles</code> - spawns units to all tiles in the array
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|<code>unit_spawn</code>
|-
|<code>event_unit_stress</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRESSED_FLAG
|<code>stressed</code>
|-
|<code>event_unit_structure</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRUCTURED_FLAG
|<code>structured</code>
|}

===== Other Events =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|<code>event_buff_activate</code>
|<code>buff</code>
<code>unit</code> - the unit the buff is applied to.

<code>event</code> - the event which triggered the activation.
|
|-
|<code>event_camera_move</code>
|<code>target_tiles</code> - moves so it can see all these
|<code>number</code> - move speed in milliseconds, 0 by default
<code>flags</code>
|-
|<code>event_camera_set_locked</code>
|<code>boolean</code>
|<code>flags</code>
|-
|<code>event_combat_banner_intro</code>
|
|
|-
|<code>event_combat_highlight_ui</code>
|<code>boolean</code>
<code>string</code> - compcon_id(?)
|<code>flags</code> - GoldenPathHighlight.AUTO_CLEAR
|-
|<code>event_combat_set_objective</code>
|<code>number</code> - index of objective to change
<code>boolean</code> - is complete?
|<code>string</code> - objective text
<code>array</code> - [2,4] -> "Search all zones! (2/4)"

<code>flags</code>
|-
|<code>event_combat_set_round_max</code>
|<code>number</code>
|
|-
|<code>event_combat_set_triggers_enabled</code>
|<code>string</code> - name of trigger group
<code>boolean</code>
|
|-
|<code>event_delay</code>
|<code>number</code> - milliseconds
|
|-
|<code>event_dialogue</code>
|<code>string</code> - conversation id
|<code>unit</code> - for dynamic text
<code>target_units</code> - for dynamic text
|-
|<code>event_dialogue_bark</code>
|<code>unit</code>
<code>string</code> - line id '''or''' raw text
|<code>target_units</code> - for dynamic text
<code>flags</code>
|-
|<code>event_dialogue_emoji</code>
|<code>unit</code>
<code>category</code> - Emoji.TYPE
|<code>number</code> - length to show in milliseconds
|-
|<code>event_dialogue_face</code>
|<code>unit</code>
<code>target_tiles</code> - tiles to look at
|
|-
|<code>event_gear_choose_and_use</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>array</code> - Array[SpecificAction] - actions to pick from
|<code>boolean</code> - is overwatch?
<code>string</code> - variant action id if mandatory

<code>flags</code> - Action.FLAG

('''if''' Action.FLAG.TARGETS_ARE_MANDATORY:

<code>target_units</code> - mandatory targets

<code>target_tiles</code> - mandatory targets)
|-
|<code>event_map_block_add</code>
|<code>target_tiles</code>
<code>category</code> - block id (int)

<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_block_remove</code>
|<code>target_tiles</code>
<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_dangerous</code>
|<code>unit</code>
<code>category</code> - Lancer.DAMAGE_TYPE - type of damage to do on failure
|<code>resource</code> - MovementType
|-
|<code>event_map_doodad_add</code>
|<code>target_tiles</code>
<code>category</code> - doodad id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_doodad_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_effect</code>
|<code>string</code> - FXGroup id
|<code>target_tiles</code>
<code>target_units</code>

<code>boolean</code> - wait for effect to end
|-
|<code>event_map_setpiece_add</code>
|<code>target_tiles</code>
<code>category</code> - setpiece id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_setpiece_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_set_water</code>
|<code>number</code> - elevation
|
|-
|<code>event_map_text</code>
|<code>string</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_map_weather_toggle</code>
|<code>string</code> - weather id
<code>boolean</code>
|
|-
|<code>event_music_play</code>
|<code>string</code> - fmod event path
|<code>flags</code>
|-
|<code>event_music_stop</code>
|
|
|-
|<code>event_round_end</code>
|
|
|-
|<code>event_round_set_next_faction</code>
|<code>category</code> - Faction.SIDE
|
|-
|<code>event_unit_attach</code>
|<code>unit</code>
<code>target_units</code>

<code>boolean</code> - attach or release
|
|-
|<code>event_unit_deploy</code>
|<code>resource</code> - UnitCore
<code>target_tiles</code>
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|-
|<code>event_unit_extract</code>
|<code>unit</code>
|<code>flags</code> - EventUnitExtract.FLAG
|-
|<code>event_unit_faction</code>
|<code>unit</code>
<code>category</code> - Faction.SIDE
|<code>flags</code> - flags[0] is Lancer.UNTIL
|-
|<code>event_unit_heal</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_mount</code>
|<code>unit</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_unit_overkill</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_overshield</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_pick_move</code>
|<code>target_unit</code>
<code>resource</code> - MovementType
|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder
'''or'''

<code>number</code> - movement budget)

<code>array</code> - Array[Vector2i] - knockback origin tiles

<code>unit</code> - origin unit

<code>gear</code> - origin gear

<code>action</code> - origin action
|-
|<code>event_unit_rename</code>
|<code>unit</code>
<code>string</code>

<code>category</code> - FetcherNameType.WHICH_NAME
|
|-
|<code>event_unit_set_stat</code>
|<code>unit</code>
<code>category</code> - Statblock.PROP

<code>number</code>
|
|-
|<code>event_unit_sitrep_tag</code>
|<code>unit</code>
<code>string</code> - sitrep tag to add/remove

<code>boolean</code>
|
|-
|<code>event_unit_teleport</code>
|<code>unit</code>
<code>target_tiles</code>
|
|-
|<code>event_zone_equip</code>
|<code>string</code> - kit id
<code>array</code> - Array[ZoneCore]
|
|-
|<code>event_zone_launch</code>
|<code>array</code> - Array[ZoneCore]
<code>flags</code> - EventUnitSpawn.FLAG
|
|-
|<code>event_zone_reinforce</code>
|<code>string</code> - reinforcement group id or name
<code>number</code> - number of units to deploy

<code>array</code> - Array[ZoneCore]
|<code>flags</code> - EventZoneReinforce.FLAG
|-
|<code>event_zone_setup</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>boolean</code> - is visible
|<code>string</code> - zone name
<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_guides</code>
|<code>array</code> - Array[ZoneCore]
|<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_name</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - zone name
|
|-
|<code>event_zone_set_properties</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>flags</code>
|<code>string</code> - zone name
|-
|<code>event_zone_set_type</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
|
|-
|<code>event_zone_set_visible</code>
|<code>array</code> - Array[ZoneCore]
<code>boolean</code> - is visible
|
|-
|<code>event_zone_usable</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - name of action

<code>object</code> - desc of action (String)
|<code>target_units</code> - unit whitelist
<code>flags</code> - EventZoneUsable.FLAG
|}

===== Module Events =====
TODO
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|
|
|
|}

Events and Context

2026-07-27T17:20:48Z

GavstarB: formatting

== The Events System ==
Lancer is a system famous for its numerous reactions and counter-reactions. In Lancer Tactics, this is handled by generating EventCore objects and then queueing them to each other in one big stack. EventCores each have an EventBase resource in their <code>base</code> variable, which defines the type of event it is. The EventCore object is typically called <code>activation</code>, <code>event</code> or <code>core</code>.

Olive's [https://wick.works/devlog/event-system-aka-how-to-handle-nested-youve-activated-my-trap-card-triggers devlog] on the subject (which you should check out just for the meme).

===== Execution Sequence =====
* Run the <code>execute_preblock()</code> function for the event's EventBase:
<blockquote>• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.

• The reaction events are ordered according to their priority (low to high).

• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.
* Run the <code>execute()</code> function for the event's EventBase:
<blockquote>• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).

• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.POST</code>.

• The reaction events are ordered according to their priority (low to high). • Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* Run child events:
<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.

• The child events are ordered according to their priority (low to high).

• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>
== Context ==
Data is passed between events within a Context object, which contains any parameters an event needs in order to execute. The Context is checked by an event immediately before calling its <code>execute()</code> function to see if it is able to run. Reactions with <code>ReactionBus.TIMING. PRE</code> can modify the Context of the event they are reacting to before the event itself occurs, which allows them to change the event's behavior.

Whether the Context object contains a specific variable can be queried using the <code>context.is_property_present()</code> function.

The Context objects contains the following variables:
{| class="wikitable mw-collapsible"
!Variable
!Type
!Additional Info
|-
|<code>action</code>
|Action
|See Actions and Reactions.
|-
|<code>array</code>
|Array
|
|-
|<code>boolean</code>
|bool
|
|-
|<code>buff</code>
|BuffCore
|
|-
|<code>category</code>
|Variant
|Represents an enum or id string.
|-
|<code>category_int</code>
|int
|The <code>category</code> variable, typed as an int. Setting this will modify the <code>category</code> variable.
|-
|<code>category_string</code>
|StringName
|The <code>category</code> variable, typed as a StringName. Setting this will modify the <code>category</code> variable.
|-
|<code>event</code>
|EventCore
|Usually the parent event of the current event.
|-
|<code>flags</code>
|Array
|Usually contains enums.
|-
|<code>gear</code>
|GearCore
|
|-
|<code>map</code>
|MapState
|Always populated.
|-
|<code>number</code>
|int
|
|-
|<code>object</code>
|Variant
|
|-
|<code>resource</code>
|Resource
|
|-
|<code>string</code>
|String
|
|-
|<code>target_tiles</code>
|Array[Vector2i]
|
|-
|<code>target_tile</code>
|Vector2i
|<code>target_tiles[0]</code>, or <code>Tile.INVALID</code> if it is empty. Setting this will add the Vector2i to <code>target_tiles</code> at index 0.
|-
|<code>target_units</code>
|Array[Unit]
|
|-
|<code>target_unit</code>
|Unit
|<code>target_units[0]</code>, or <code>null</code> if it is empty. Setting this will add the Unit to <code>target_units</code> at index 0.
|-
|<code>unit</code>
|Unit
|
|}

== Event Creation ==
A Context object is usually created from a dictionary, where each key corresponds to the name of a variable:
var context = Context.create({
string = "Example Context",
boolean = true
})
Events are almost always created using the functions on their parent event, although it is possible to create one directly to make a virtual event not queued to any other event.

An event can be queued to the <code>activation</code> event with:
activation.queue_event(&"event_example_id", {
string = "Example Event",
boolean = true
}, Priority.ACTIVATE.late_followup)
Events can also be executed immediately:
await activation.execute_event(&"event_example_id", {
string = "Example Event",
boolean = true
})
'''<big>As with any other <code>await</code> function, check your references are not <code>null</code> before proceeding.</big>'''

== Event Types ==
The scripts defining the game's events can be found in the <code>res://content/events/</code> folder.

===== Events with Reactions =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
!Reactions
|-
|<code>event_combat_end</code>
|<code>boolean</code> - victory?
|
|<code>combat_end</code>
|-
|<code>event_combat_set_state</code>
|<code>string</code>
<code>object</code>
|
|<code>modified_combat_state</code>
|-
|<code>event_combat_start</code>
|
|
|<code>combat_start</code>
|-
|<code>event_combat_trigger_signal</code>
|<code>string</code>
|<code>number</code>
<code>boolean</code>

<code>unit</code>

<code>object</code>

<code>array</code> - if given, emits the signal more than once for each item in the array
|<code>trigger_signal</code>
|-
|<code>event_gear_activate</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>
|<code>target_tiles</code> - targeting hint
<code>target_units</code> - targeting hint

<code>event</code> - parent event during reactions

<code>flags</code> - Action.FLAG

<code>object</code> - Pathfinder if can move before taking action

<code>string</code> - id of variant Action to be used
|<code>unit_action</code> - generates a fake Context matching that of <code>event_unit_action</code>. Context cannot be modified by <code>PRE</code> events
<code>stabilize</code>
|-
|<code>event_gear_destroy</code>
|<code>unit</code>
<code>gear</code>
|
|<code>gear_destruction</code>
|-
|<code>event_gear_reload</code>
|<code>unit</code>
(<code>gear</code>

'''and/or'''

<code>array</code> - Array[GearCore])
|
|<code>reload</code>
|-
|<code>event_map_damage</code>
|<code>target_tiles</code>
<code>number</code>
|<code>flags</code> - EventMapDamage.FLAG
<code>object</code> - elevation to destroy down to (int)

<code>boolean</code> - set to true if terrain got destroyed
|<code>terrain_damage</code>
|-
|<code>event_round_new</code>
|
|
|<code>new_round</code>
|-
|<code>event_turn_end</code>
|<code>unit</code>
|
|<code>end_turn</code>
|-
|<code>event_turn_start</code>
|<code>unit</code>
|
|<code>new_turn</code>
|-
|<code>event_unit_action</code>
|<code>unit</code>
<code>string</code> - kit id

<code>number</code> - action index
|<code>target_tiles</code>
<code>target_units</code>

<code>flags</code> - Action.FLAG

<code>gear</code>

<code>action</code>
|executes an <code>event_gear_activate</code> which in turn runs <code>unit_action</code> reactions with a context matching this event
|-
|<code>event_unit_apply_status</code>
|<code>unit</code>
<code>category</code>

<code>flags</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>PRE</code>)
|-
|<code>event_unit_attack</code>
|<code>target_unit</code> - attacked unit
<code>unit</code> - attacking unit

<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary

<code>event</code> - <code>event_unit_attack_declared</code>
|<code>flags</code> - Action.FLAG
|<code>attack</code>
|-
|<code>event_unit_attack_declared</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary
|
|<code>attack_declared</code>
|-
|<code>event_unit_boost</code>
|<code>unit</code>
|<code>event</code>
|<code>boost</code>
|-
|<code>event_unit_brace</code>
|<code>unit</code>
|
|<code>brace</code>
|-
|<code>event_unit_clear_status</code>
|<code>unit</code>
<code>category</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>POST</code>)
|-
|<code>event_unit_collide</code>
|<code>unit</code>
<code>target_tiles</code> - tile collided with

<code>event</code>
|
|<code>collision</code>
|-
|<code>event_unit_cool</code>
|<code>unit</code>
<code>number</code>
|
|<code>clear_heat</code>
|-
|<code>event_unit_damage</code>
|<code>unit</code>
<code>number</code>
|<code>category</code> - Lancer.DAMAGE_TYPE - default kinetic
<code>object</code> - AttackRoll

<code>flags</code> - EventService.DAMAGE_FLAG

<code>target_unit</code> - attacker

<code>gear</code> - attacker gear

<code>action</code> - attacker Action
|<code>damage</code>
|-
|<code>event_unit_die</code>
|<code>unit</code>
|<code>flags</code> - EventService.DIE_FLAG
|<code>death</code>
|-
|<code>event_unit_exile</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>exiled</code>
|-
|<code>event_unit_intangible</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>intangible</code>
|-
|<code>event_unit_lose_hidden</code>
|<code>unit</code>
|
|<code>lose_hidden</code>
|-
|<code>event_unit_meltdown</code>
|<code>unit</code>
|
|<code>meltdown</code>
|-
|<code>event_unit_move</code>
|<code>unit</code>
(<code>target_tiles</code> - path or single tile to path to. in <code>PRE</code> reactions to <code>step</code>, holds the tile the unit is about to step into

'''or'''

<code>array</code> - Array[Pathfinder.Step] - final path)
|<code>resource</code> - MovementType
<code>flags</code> - EventUnitMove.FLAG

<code>object</code> - SpecificAction which caused the move
|<code>step</code>
<code>entire_movement</code>
|-
|<code>event_unit_save</code>
|<code>target_unit</code>
<code>category</code> - Lancer.HASE
|<code>unit</code> - origin unit
<code>gear</code> - origin gear

<code>action</code> - origin action

<code>string</code> - combat state key for success boolean to be saved to
|<code>forced_save</code>
|-
|<code>event_unit_spawn</code>
|<code>unit</code>
<code>target_tiles</code> - spawns units to all tiles in the array
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|<code>unit_spawn</code>
|-
|<code>event_unit_stress</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRESSED_FLAG
|<code>stressed</code>
|-
|<code>event_unit_structure</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRUCTURED_FLAG
|<code>structured</code>
|}

===== Other Events =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|<code>event_buff_activate</code>
|<code>buff</code>
<code>unit</code> - the unit the buff is applied to.

<code>event</code> - the event which triggered the activation.
|
|-
|<code>event_camera_move</code>
|<code>target_tiles</code> - moves so it can see all these
|<code>number</code> - move speed in milliseconds, 0 by default
<code>flags</code>
|-
|<code>event_camera_set_locked</code>
|<code>boolean</code>
|<code>flags</code>
|-
|<code>event_combat_banner_intro</code>
|
|
|-
|<code>event_combat_highlight_ui</code>
|<code>boolean</code>
<code>string</code> - compcon_id(?)
|<code>flags</code> - GoldenPathHighlight.AUTO_CLEAR
|-
|<code>event_combat_set_objective</code>
|<code>number</code> - index of objective to change
<code>boolean</code> - is complete?
|<code>string</code> - objective text
<code>array</code> - [2,4] -> "Search all zones! (2/4)"

<code>flags</code>
|-
|<code>event_combat_set_round_max</code>
|<code>number</code>
|
|-
|<code>event_combat_set_triggers_enabled</code>
|<code>string</code> - name of trigger group
<code>boolean</code>
|
|-
|<code>event_delay</code>
|<code>number</code> - milliseconds
|
|-
|<code>event_dialogue</code>
|<code>string</code> - conversation id
|<code>unit</code> - for dynamic text
<code>target_units</code> - for dynamic text
|-
|<code>event_dialogue_bark</code>
|<code>unit</code>
<code>string</code> - line id '''or''' raw text
|<code>target_units</code> - for dynamic text
<code>flags</code>
|-
|<code>event_dialogue_emoji</code>
|<code>unit</code>
<code>category</code> - Emoji.TYPE
|<code>number</code> - length to show in milliseconds
|-
|<code>event_dialogue_face</code>
|<code>unit</code>
<code>target_tiles</code> - tiles to look at
|
|-
|<code>event_gear_choose_and_use</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>array</code> - Array[SpecificAction] - actions to pick from
|<code>boolean</code> - is overwatch?
<code>string</code> - variant action id if mandatory

<code>flags</code> - Action.FLAG

('''if''' Action.FLAG.TARGETS_ARE_MANDATORY:

<code>target_units</code> - mandatory targets

<code>target_tiles</code> - mandatory targets)
|-
|<code>event_map_block_add</code>
|<code>target_tiles</code>
<code>category</code> - block id (int)

<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_block_remove</code>
|<code>target_tiles</code>
<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_dangerous</code>
|<code>unit</code>
<code>category</code> - Lancer.DAMAGE_TYPE - type of damage to do on failure
|<code>resource</code> - MovementType
|-
|<code>event_map_doodad_add</code>
|<code>target_tiles</code>
<code>category</code> - doodad id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_doodad_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_effect</code>
|<code>string</code> - FXGroup id
|<code>target_tiles</code>
<code>target_units</code>

<code>boolean</code> - wait for effect to end
|-
|<code>event_map_setpiece_add</code>
|<code>target_tiles</code>
<code>category</code> - setpiece id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_setpiece_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_set_water</code>
|<code>number</code> - elevation
|
|-
|<code>event_map_text</code>
|<code>string</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_map_weather_toggle</code>
|<code>string</code> - weather id
<code>boolean</code>
|
|-
|<code>event_music_play</code>
|<code>string</code> - fmod event path
|<code>flags</code>
|-
|<code>event_music_stop</code>
|
|
|-
|<code>event_round_end</code>
|
|
|-
|<code>event_round_set_next_faction</code>
|<code>category</code> - Faction.SIDE
|
|-
|<code>event_unit_attach</code>
|<code>unit</code>
<code>target_units</code>

<code>boolean</code> - attach or release
|
|-
|<code>event_unit_deploy</code>
|<code>resource</code> - UnitCore
<code>target_tiles</code>
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|-
|<code>event_unit_extract</code>
|<code>unit</code>
|<code>flags</code> - EventUnitExtract.FLAG
|-
|<code>event_unit_faction</code>
|<code>unit</code>
<code>category</code> - Faction.SIDE
|<code>flags</code> - flags[0] is Lancer.UNTIL
|-
|<code>event_unit_heal</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_mount</code>
|<code>unit</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_unit_overkill</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_overshield</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_pick_move</code>
|<code>target_unit</code>
<code>resource</code> - MovementType
|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder
'''or'''

<code>number</code> - movement budget)

<code>array</code> - Array[Vector2i] - knockback origin tiles

<code>unit</code> - origin unit

<code>gear</code> - origin gear

<code>action</code> - origin action
|-
|<code>event_unit_rename</code>
|<code>unit</code>
<code>string</code>

<code>category</code> - FetcherNameType.WHICH_NAME
|
|-
|<code>event_unit_set_stat</code>
|<code>unit</code>
<code>category</code> - Statblock.PROP

<code>number</code>
|
|-
|<code>event_unit_sitrep_tag</code>
|<code>unit</code>
<code>string</code> - sitrep tag to add/remove

<code>boolean</code>
|
|-
|<code>event_unit_teleport</code>
|<code>unit</code>
<code>target_tiles</code>
|
|-
|<code>event_zone_equip</code>
|<code>string</code> - kit id
<code>array</code> - Array[ZoneCore]
|
|-
|<code>event_zone_launch</code>
|<code>array</code> - Array[ZoneCore]
<code>flags</code> - EventUnitSpawn.FLAG
|
|-
|<code>event_zone_reinforce</code>
|<code>string</code> - reinforcement group id or name
<code>number</code> - number of units to deploy

<code>array</code> - Array[ZoneCore]
|<code>flags</code> - EventZoneReinforce.FLAG
|-
|<code>event_zone_setup</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>boolean</code> - is visible
|<code>string</code> - zone name
<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_guides</code>
|<code>array</code> - Array[ZoneCore]
|<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_name</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - zone name
|
|-
|<code>event_zone_set_properties</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>flags</code>
|<code>string</code> - zone name
|-
|<code>event_zone_set_type</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
|
|-
|<code>event_zone_set_visible</code>
|<code>array</code> - Array[ZoneCore]
<code>boolean</code> - is visible
|
|-
|<code>event_zone_usable</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - name of action

<code>object</code> - desc of action (String)
|<code>target_units</code> - unit whitelist
<code>flags</code> - EventZoneUsable.FLAG
|}

===== Module Events =====
TODO
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|
|
|
|}

Events and Context

2026-07-27T17:19:09Z

GavstarB: formatting

== The Events System ==
Lancer is a system famous for its numerous reactions and counter-reactions. In Lancer Tactics, this is handled by generating EventCore objects and then queueing them to each other in one big stack. EventCores each have an EventBase resource in their <code>base</code> variable, which defines the type of event it is. The EventCore object is typically called <code>activation</code>, <code>event</code> or <code>core</code>.

Olive's [https://wick.works/devlog/event-system-aka-how-to-handle-nested-youve-activated-my-trap-card-triggers devlog] on the subject (which you should check out just for the meme).

===== Execution Sequence =====
* Run the <code>execute_preblock()</code> function for the event's EventBase:
<blockquote>• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.

• The reaction events are ordered according to their priority (low to high).

• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.
* Run the <code>execute()</code> function for the event's EventBase:
<blockquote>• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).

• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.POST</code>.

• The reaction events are ordered according to their priority (low to high). • Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* Run child events:
<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.

• The child events are ordered according to their priority (low to high).

• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>
== Context ==
Data is passed between events within a Context object, which contains any parameters an event needs in order to execute. The Context is checked by an event immediately before calling its <code>execute()</code> function to see if it is able to run. Reactions with <code>ReactionBus.TIMING. PRE</code> can modify the Context of the event they are reacting to before the event itself occurs, which allows them to change the event's behavior.

Whether the Context object contains a specific variable can be queried using the <code>context.is_property_present()</code> function.

The Context objects contains the following variables:
{| class="wikitable mw-collapsible"
!Variable
!Type
!Additional Info
|-
|<code>action</code>
|Action
|See Actions and Reactions.
|-
|<code>array</code>
|Array
|
|-
|<code>boolean</code>
|bool
|
|-
|<code>buff</code>
|BuffCore
|
|-
|<code>category</code>
|Variant
|Represents an enum or id string.
|-
|<code>category_int</code>
|int
|The <code>category</code> variable, typed as an int. Setting this will modify the <code>category</code> variable.
|-
|<code>category_string</code>
|StringName
|The <code>category</code> variable, typed as a StringName. Setting this will modify the <code>category</code> variable.
|-
|<code>event</code>
|EventCore
|Usually the parent event of the current event.
|-
|<code>flags</code>
|Array
|Usually contains enums.
|-
|<code>gear</code>
|GearCore
|
|-
|<code>map</code>
|MapState
|Always populated.
|-
|<code>number</code>
|int
|
|-
|<code>object</code>
|Variant
|
|-
|<code>resource</code>
|Resource
|
|-
|<code>string</code>
|String
|
|-
|<code>target_tiles</code>
|Array[Vector2i]
|
|-
|<code>target_tile</code>
|Vector2i
|<code>target_tiles[0]</code>, or <code>Tile.INVALID</code> if it is empty. Setting this will add the Vector2i to <code>target_tiles</code> at index 0.
|-
|<code>target_units</code>
|Array[Unit]
|
|-
|<code>target_unit</code>
|Unit
|<code>target_units[0]</code>, or <code>null</code> if it is empty. Setting this will add the Unit to <code>target_units</code> at index 0.
|-
|<code>unit</code>
|Unit
|
|}

== Event Creation ==
A Context object is usually created from a dictionary, where each key corresponds to the name of a variable:
var context = Context.create({
string = "Example Context",
boolean = true
})
Events are almost always created using the functions on their parent event, although it is possible to create one directly to make a virtual event not queued to any other event.

An event can be queued to the <code>activation</code> event with:
activation.queue_event(&"event_example_id", {
string = "Example Event",
boolean = true
}, Priority.ACTIVATE.late_followup)
Events can also be executed immediately:
await activation.execute_event(&"event_example_id", {
string = "Example Event",
boolean = true
})
'''<big>As with any other <code>await</code> function, check your references are not <code>null</code> before proceeding.</big>'''

== Event Types ==
The scripts defining the game's events can be found in the <code>res://content/events/</code> folder.

===== Events with Reactions =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
!Reactions
|-
|<code>event_combat_end</code>
|<code>boolean</code> - victory?
|
|<code>combat_end</code>
|-
|<code>event_combat_set_state</code>
|<code>string</code>
<code>object</code>
|
|<code>modified_combat_state</code>
|-
|<code>event_combat_start</code>
|
|
|<code>combat_start</code>
|-
|<code>event_combat_trigger_signal</code>
|<code>string</code>
|<code>number</code>
<code>boolean</code>

<code>unit</code>

<code>object</code>

<code>array</code> - if given, emits the signal more than once for each item in the array
|<code>trigger_signal</code>
|-
|<code>event_gear_activate</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>
|<code>target_tiles</code> - targeting hint
<code>target_units</code> - targeting hint

<code>event</code> - parent event during reactions

<code>flags</code> - Action.FLAG

<code>object</code> - Pathfinder if can move before taking action

<code>string</code> - id of variant Action to be used
|<code>unit_action</code> - generates a fake Context matching that of <code>event_unit_action</code>. Context cannot be modified by <code>PRE</code> events
<code>stabilize</code>
|-
|<code>event_gear_destroy</code>
|<code>unit</code>
<code>gear</code>
|
|<code>gear_destruction</code>
|-
|<code>event_gear_reload</code>
|<code>unit</code>
(<code>gear</code>

'''and/or'''

<code>array</code> - Array[GearCore])
|
|<code>reload</code>
|-
|<code>event_map_damage</code>
|<code>target_tiles</code>
<code>number</code>
|<code>flags</code> - EventMapDamage.FLAG
<code>object</code> - elevation to destroy down to (int)

<code>boolean</code> - set to true if terrain got destroyed
|<code>terrain_damage</code>
|-
|<code>event_round_new</code>
|
|
|<code>new_round</code>
|-
|<code>event_turn_end</code>
|<code>unit</code>
|
|<code>end_turn</code>
|-
|<code>event_turn_start</code>
|<code>unit</code>
|
|<code>new_turn</code>
|-
|<code>event_unit_action</code>
|<code>unit</code>
<code>string</code> - kit id

<code>number</code> - action index
|<code>target_tiles</code>
<code>target_units</code>

<code>flags</code> - Action.FLAG

<code>gear</code>

<code>action</code>
|executes an <code>event_gear_activate</code> which in turn runs <code>unit_action</code> reactions with a context matching this event
|-
|<code>event_unit_apply_status</code>
|<code>unit</code>
<code>category</code>

<code>flags</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>PRE</code>)
|-
|<code>event_unit_attack</code>
|<code>target_unit</code> - attacked unit
<code>unit</code> - attacking unit

<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary

<code>event</code> - <code>event_unit_attack_declared</code>
|<code>flags</code> - Action.FLAG
|<code>attack</code>
|-
|<code>event_unit_attack_declared</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary
|
|<code>attack_declared</code>
|-
|<code>event_unit_boost</code>
|<code>unit</code>
|<code>event</code>
|<code>boost</code>
|-
|<code>event_unit_brace</code>
|<code>unit</code>
|
|<code>brace</code>
|-
|<code>event_unit_clear_status</code>
|<code>unit</code>
<code>category</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>POST</code>)
|-
|<code>event_unit_collide</code>
|<code>unit</code>
<code>target_tiles</code> - tile collided with

<code>event</code>
|
|<code>collision</code>
|-
|<code>event_unit_cool</code>
|<code>unit</code>
<code>number</code>
|
|<code>clear_heat</code>
|-
|<code>event_unit_damage</code>
|<code>unit</code>
<code>number</code>
|<code>category</code> - Lancer.DAMAGE_TYPE - default kinetic
<code>object</code> - AttackRoll

<code>flags</code> - EventService.DAMAGE_FLAG

<code>target_unit</code> - attacker

<code>gear</code> - attacker gear

<code>action</code> - attacker Action
|<code>damage</code>
|-
|<code>event_unit_die</code>
|<code>unit</code>
|<code>flags</code> - EventService.DIE_FLAG
|<code>death</code>
|-
|<code>event_unit_exile</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>exiled</code>
|-
|<code>event_unit_intangible</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>intangible</code>
|-
|<code>event_unit_lose_hidden</code>
|<code>unit</code>
|
|<code>lose_hidden</code>
|-
|<code>event_unit_meltdown</code>
|<code>unit</code>
|
|<code>meltdown</code>
|-
|<code>event_unit_move</code>
|<code>unit</code>
(<code>target_tiles</code> - path or single tile to path to. in <code>PRE</code> reactions to <code>step</code>, holds the tile the unit is about to step into

'''or'''

<code>array</code> - Array[Pathfinder.Step] - final path)
|<code>resource</code> - MovementType
<code>flags</code> - EventUnitMove.FLAG

<code>object</code> - SpecificAction which caused the move
|<code>step</code>
<code>entire_movement</code>
|-
|<code>event_unit_save</code>
|<code>target_unit</code>
<code>category</code> - Lancer.HASE
|<code>unit</code> - origin unit
<code>gear</code> - origin gear

<code>action</code> - origin action

<code>string</code> - combat state key for success boolean to be saved to
|<code>forced_save</code>
|-
|<code>event_unit_spawn</code>
|<code>unit</code>
<code>target_tiles</code> - spawns units to all tiles in the array
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|<code>unit_spawn</code>
|-
|<code>event_unit_stress</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRESSED_FLAG
|<code>stressed</code>
|-
|<code>event_unit_structure</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRUCTURED_FLAG
|<code>structured</code>
|}

===== Other Events =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|<code>event_buff_activate</code>
|<code>buff</code>
<code>unit</code> - the unit the buff is applied to.

<code>event</code> - the event which triggered the activation.
|
|-
|<code>event_camera_move</code>
|<code>target_tiles</code> - moves so it can see all these
|<code>number</code> - move speed in milliseconds, 0 by default
<code>flags</code>
|-
|<code>event_camera_set_locked</code>
|<code>boolean</code>
|<code>flags</code>
|-
|<code>event_combat_banner_intro</code>
|
|
|-
|<code>event_combat_highlight_ui</code>
|<code>boolean</code>
<code>string</code> - compcon_id(?)
|<code>flags</code> - GoldenPathHighlight.AUTO_CLEAR
|-
|<code>event_combat_set_objective</code>
|<code>number</code> - index of objective to change
<code>boolean</code> - is complete?
|<code>string</code> - objective text
<code>array</code> - [2,4] -> "Search all zones! (2/4)"

<code>flags</code>
|-
|<code>event_combat_set_round_max</code>
|<code>number</code>
|
|-
|<code>event_combat_set_triggers_enabled</code>
|<code>string</code> - name of trigger group
<code>boolean</code>
|
|-
|<code>event_delay</code>
|<code>number</code> - milliseconds
|
|-
|<code>event_dialogue</code>
|<code>string</code> - conversation id
|<code>unit</code> - for dynamic text
<code>target_units</code> - for dynamic text
|-
|<code>event_dialogue_bark</code>
|<code>unit</code>
<code>string</code> - line id '''or''' raw text
|<code>target_units</code> - for dynamic text
<code>flags</code>
|-
|<code>event_dialogue_emoji</code>
|<code>unit</code>
<code>category</code> - Emoji.TYPE
|<code>number</code> - length to show in milliseconds
|-
|<code>event_dialogue_face</code>
|<code>unit</code>
<code>target_tiles</code> - tiles to look at
|
|-
|<code>event_gear_choose_and_use</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>array</code> - Array[SpecificAction] - actions to pick from
|<code>boolean</code> - is overwatch?
<code>string</code> - variant action id if mandatory

<code>flags</code> - Action.FLAG

('''if''' Action.FLAG.TARGETS_ARE_MANDATORY:

<code>target_units</code> - mandatory targets

<code>target_tiles</code> - mandatory targets)
|-
|<code>event_map_block_add</code>
|<code>target_tiles</code>
<code>category</code> - block id (int)

<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_block_remove</code>
|<code>target_tiles</code>
<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_dangerous</code>
|<code>unit</code>
<code>category</code> - Lancer.DAMAGE_TYPE - type of damage to do on failure
|<code>resource</code> - MovementType
|-
|<code>event_map_doodad_add</code>
|<code>target_tiles</code>
<code>category</code> - doodad id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_doodad_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_effect</code>
|<code>string</code> - FXGroup id
|<code>target_tiles</code>
<code>target_units</code>

<code>boolean</code> - wait for effect to end
|-
|<code>event_map_setpiece_add</code>
|<code>target_tiles</code>
<code>category</code> - setpiece id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_setpiece_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_set_water</code>
|<code>number</code> - elevation
|
|-
|<code>event_map_text</code>
|<code>string</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_map_weather_toggle</code>
|<code>string</code> - weather id
<code>boolean</code>
|
|-
|<code>event_music_play</code>
|<code>string</code> - fmod event path
|<code>flags</code>
|-
|<code>event_music_stop</code>
|
|
|-
|<code>event_round_end</code>
|
|
|-
|<code>event_round_set_next_faction</code>
|<code>category</code> - Faction.SIDE
|
|-
|<code>event_unit_attach</code>
|<code>unit</code>
<code>target_units</code>

<code>boolean</code> - attach or release
|
|-
|<code>event_unit_deploy</code>
|<code>resource</code> - UnitCore
<code>target_tiles</code>
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|-
|<code>event_unit_extract</code>
|<code>unit</code>
|<code>flags</code> - EventUnitExtract.FLAG
|-
|<code>event_unit_faction</code>
|<code>unit</code>
<code>category</code> - Faction.SIDE
|<code>flags</code> - flags[0] is Lancer.UNTIL
|-
|<code>event_unit_heal</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_mount</code>
|<code>unit</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_unit_overkill</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_overshield</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_pick_move</code>
|<code>target_unit</code>
<code>resource</code> - MovementType
|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder
'''or'''

<code>number</code> - movement budget)

<code>array</code> - Array[Vector2i] - knockback origin tiles

<code>unit</code> - origin unit

<code>gear</code> - origin gear

<code>action</code> - origin action
|-
|<code>event_unit_rename</code>
|<code>unit</code>
<code>string</code>

<code>category</code> - FetcherNameType.WHICH_NAME
|
|-
|<code>event_unit_set_stat</code>
|<code>unit</code>
<code>category</code> - Statblock.PROP

<code>number</code>
|
|-
|<code>event_unit_sitrep_tag</code>
|<code>unit</code>
<code>string</code> - sitrep tag to add/remove

<code>boolean</code>
|
|-
|<code>event_unit_teleport</code>
|<code>unit</code>
<code>target_tiles</code>
|
|-
|<code>event_zone_equip</code>
|<code>string</code> - kit id
<code>array</code> - Array[ZoneCore]
|
|-
|<code>event_zone_launch</code>
|<code>array</code> - Array[ZoneCore]
<code>flags</code> - EventUnitSpawn.FLAG
|
|-
|<code>event_zone_reinforce</code>
|<code>string</code> - reinforcement group id or name
<code>number</code> - number of units to deploy

<code>array</code> - Array[ZoneCore]
|<code>flags</code> - EventZoneReinforce.FLAG
|-
|<code>event_zone_setup</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>boolean</code> - is visible
|<code>string</code> - zone name
<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_guides</code>
|<code>array</code> - Array[ZoneCore]
|<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_name</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - zone name
|
|-
|<code>event_zone_set_properties</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE

<code>flags</code>
|<code>string</code> - zone name
|-
|<code>event_zone_set_type</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
|
|-
|<code>event_zone_set_visible</code>
|<code>array</code> - Array[ZoneCore]
<code>boolean</code> - is visible
|
|-
|event_zone_usable
|<code>array</code> - Array[ZoneCore]
<code>string</code> - name of action

<code>object</code> - desc of action (String)
|<code>target_units</code> - unit whitelist
<code>flags</code> - EventZoneUsable.FLAG
|}

===== Module Events =====
TODO
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|
|
|
|}

Events and Context

2026-07-27T17:14:35Z

GavstarB: finished first two event types table

== The Events System ==
Lancer is a system famous for its numerous reactions and counter-reactions. In Lancer Tactics, this is handled by generating EventCore objects and then queueing them to each other in one big stack. EventCores each have an EventBase resource in their <code>base</code> variable, which defines the type of event it is. The EventCore object is typically called <code>activation</code>, <code>event</code> or <code>core</code>.

Olive's [https://wick.works/devlog/event-system-aka-how-to-handle-nested-youve-activated-my-trap-card-triggers devlog] on the subject (which you should check out just for the meme).

===== Execution Sequence =====
* Run the <code>execute_preblock()</code> function for the event's EventBase:
<blockquote>• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.

• The reaction events are ordered according to their priority (low to high).

• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.
* Run the <code>execute()</code> function for the event's EventBase:
<blockquote>• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).

• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.POST</code>.

• The reaction events are ordered according to their priority (low to high). • Loop through the reaction events and run the whole execution sequence for each reaction event in turn.</blockquote>
* Run child events:
<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.

• The child events are ordered according to their priority (low to high).

• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>
== Context ==
Data is passed between events within a Context object, which contains any parameters an event needs in order to execute. The Context is checked by an event immediately before calling its <code>execute()</code> function to see if it is able to run. Reactions with <code>ReactionBus.TIMING. PRE</code> can modify the Context of the event they are reacting to before the event itself occurs, which allows them to change the event's behavior.

Whether the Context object contains a specific variable can be queried using the <code>context.is_property_present()</code> function.

The Context objects contains the following variables:
{| class="wikitable mw-collapsible"
!Variable
!Type
!Additional Info
|-
|<code>action</code>
|Action
|See Actions and Reactions.
|-
|<code>array</code>
|Array
|
|-
|<code>boolean</code>
|bool
|
|-
|<code>buff</code>
|BuffCore
|
|-
|<code>category</code>
|Variant
|Represents an enum or id string.
|-
|<code>category_int</code>
|int
|The <code>category</code> variable, typed as an int. Setting this will modify the <code>category</code> variable.
|-
|<code>category_string</code>
|StringName
|The <code>category</code> variable, typed as a StringName. Setting this will modify the <code>category</code> variable.
|-
|<code>event</code>
|EventCore
|Usually the parent event of the current event.
|-
|<code>flags</code>
|Array
|Usually contains enums.
|-
|<code>gear</code>
|GearCore
|
|-
|<code>map</code>
|MapState
|Always populated.
|-
|<code>number</code>
|int
|
|-
|<code>object</code>
|Variant
|
|-
|<code>resource</code>
|Resource
|
|-
|<code>string</code>
|String
|
|-
|<code>target_tiles</code>
|Array[Vector2i]
|
|-
|<code>target_tile</code>
|Vector2i
|<code>target_tiles[0]</code>, or <code>Tile.INVALID</code> if it is empty. Setting this will add the Vector2i to <code>target_tiles</code> at index 0.
|-
|<code>target_units</code>
|Array[Unit]
|
|-
|<code>target_unit</code>
|Unit
|<code>target_units[0]</code>, or <code>null</code> if it is empty. Setting this will add the Unit to <code>target_units</code> at index 0.
|-
|<code>unit</code>
|Unit
|
|}

== Event Creation ==
A Context object is usually created from a dictionary, where each key corresponds to the name of a variable:
var context = Context.create({
string = "Example Context",
boolean = true
})
Events are almost always created using the functions on their parent event, although it is possible to create one directly to make a virtual event not queued to any other event.

An event can be queued to the <code>activation</code> event with:
activation.queue_event(&"event_example_id", {
string = "Example Event",
boolean = true
}, Priority.ACTIVATE.late_followup)
Events can also be executed immediately:
await activation.execute_event(&"event_example_id", {
string = "Example Event",
boolean = true
})
'''<big>As with any other <code>await</code> function, check your references are not <code>null</code> before proceeding.</big>'''

== Event Types ==
The scripts defining the game's events can be found in the <code>res://content/events/</code> folder.

===== Events with Reactions =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
!Reactions
|-
|<code>event_combat_end</code>
|<code>boolean</code> - victory?
|
|<code>combat_end</code>
|-
|<code>event_combat_set_state</code>
|<code>string</code>
<code>object</code>
|
|<code>modified_combat_state</code>
|-
|<code>event_combat_start</code>
|
|
|<code>combat_start</code>
|-
|<code>event_combat_trigger_signal</code>
|<code>string</code>
|<code>number</code>
<code>boolean</code>

<code>unit</code>

<code>object</code>

<code>array</code> - if given, emits the signal more than once for each item in the array
|<code>trigger_signal</code>
|-
|<code>event_gear_activate</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>
|<code>target_tiles</code> - targeting hint
<code>target_units</code> - targeting hint

<code>event</code> - parent event during reactions

<code>flags</code> - Action.FLAG

<code>object</code> - Pathfinder if can move before taking action

<code>string</code> - id of variant Action to be used
|<code>unit_action</code> - generates a fake Context matching that of <code>event_unit_action</code>. Context cannot be modified by <code>PRE</code> events
<code>stabilize</code>
|-
|<code>event_gear_destroy</code>
|<code>unit</code>
<code>gear</code>
|
|<code>gear_destruction</code>
|-
|<code>event_gear_reload</code>
|<code>unit</code>
(<code>gear</code>

'''and/or'''

<code>array</code> - Array[GearCore])
|
|<code>reload</code>
|-
|<code>event_map_damage</code>
|<code>target_tiles</code>
<code>number</code>
|<code>flags</code> - EventMapDamage.FLAG
<code>object</code> - elevation to destroy down to (int)

<code>boolean</code> - set to true if terrain got destroyed
|<code>terrain_damage</code>
|-
|<code>event_round_new</code>
|
|
|<code>new_round</code>
|-
|<code>event_turn_end</code>
|<code>unit</code>
|
|<code>end_turn</code>
|-
|<code>event_turn_start</code>
|<code>unit</code>
|
|<code>new_turn</code>
|-
|<code>event_unit_action</code>
|<code>unit</code>
<code>string</code> - kit id
<code>number</code> - action index
|<code>target_tiles</code>
<code>target_units</code>
<code>flags</code> - Action.FLAG
<code>gear</code>
<code>action</code>
|executes an <code>event_gear_activate</code> which in turn runs <code>unit_action</code> reactions with a context matching this event
|-
|<code>event_unit_apply_status</code>
|<code>unit</code>
<code>category</code>
<code>flags</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>PRE</code>)
|-
|<code>event_unit_attack</code>
|<code>target_unit</code> - attacked unit
<code>unit</code> - attacking unit

<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary

<code>event</code> - <code>event_unit_attack_declared</code>
|<code>flags</code> - Action.FLAG
|<code>attack</code>
|-
|<code>event_unit_attack_declared</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>resource</code> - DeclaredAttackSummary
|
|<code>attack_declared</code>
|-
|<code>event_unit_boost</code>
|<code>unit</code>
|<code>event</code>
|<code>boost</code>
|-
|<code>event_unit_brace</code>
|<code>unit</code>
|
|<code>brace</code>
|-
|<code>event_unit_clear_status</code>
|<code>unit</code>
<code>category</code>
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>statuses_changed</code> (only <code>POST</code>)
|-
|<code>event_unit_collide</code>
|<code>unit</code>
<code>target_tiles</code> - tile collided with
<code>event</code>
|
|<code>collision</code>
|-
|<code>event_unit_cool</code>
|<code>unit</code>
<code>number</code>
|
|<code>clear_heat</code>
|-
|<code>event_unit_damage</code>
|<code>unit</code>
<code>number</code>
|<code>category</code> - Lancer.DAMAGE_TYPE - default kinetic
<code>object</code> - AttackRoll

<code>flags</code> - EventService.DAMAGE_FLAG

<code>target_unit</code> - attacker

<code>gear</code> - attacker gear

<code>action</code> - attacker Action
|<code>damage</code>
|-
|<code>event_unit_die</code>
|<code>unit</code>
|<code>flags</code> - EventService.DIE_FLAG
|<code>death</code>
|-
|<code>event_unit_exile</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>exiled</code>
|-
|<code>event_unit_intangible</code>
|<code>unit</code>
<code>flags</code> - Lancer.UNTIL
|<code>string</code> - persistent id of source gear
<code>gear</code> - source
|<code>intangible</code>
|-
|<code>event_unit_lose_hidden</code>
|<code>unit</code>
|
|<code>lose_hidden</code>
|-
|<code>event_unit_meltdown</code>
|<code>unit</code>
|
|<code>meltdown</code>
|-
|<code>event_unit_move</code>
|<code>unit</code>
(<code>target_tiles</code> - path or single tile to path to. in <code>PRE</code> reactions to <code>step</code>, holds the tile the unit is about to step into

'''or'''

<code>array</code> - Array[Pathfinder.Step] - final path)
|<code>resource</code> - MovementType
<code>flags</code> - EventUnitMove.FLAG

<code>object</code> - SpecificAction which caused the move
|<code>step</code>
<code>entire_movement</code>
|-
|<code>event_unit_save</code>
|<code>target_unit</code>
<code>category</code> - Lancer.HASE
|<code>unit</code> - origin unit
<code>gear</code> - origin gear
<code>action</code> - origin action
<code>string</code> - combat state key for success boolean to be saved to
|<code>forced_save</code>
|-
|<code>event_unit_spawn</code>
|<code>unit</code>
<code>target_tiles</code> - spawns units to all tiles in the array
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|<code>unit_spawn</code>
|-
|<code>event_unit_stress</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRESSED_FLAG
|<code>stressed</code>
|-
|<code>event_unit_structure</code>
|<code>unit</code>
|<code>flags</code> - EventService.STRUCTURED_FLAG
|<code>structured</code>
|}

===== Other Events =====
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|<code>event_buff_activate</code>
|<code>buff</code>
<code>unit</code> - the unit the buff is applied to.

<code>event</code> - the event which triggered the activation.
|
|-
|<code>event_camera_move</code>
|<code>target_tiles</code> - moves so it can see all these
|<code>number</code> - move speed in milliseconds, 0 by default
<code>flags</code>
|-
|<code>event_camera_set_locked</code>
|<code>boolean</code>
|<code>flags</code>
|-
|<code>event_combat_banner_intro</code>
|
|
|-
|<code>event_combat_highlight_ui</code>
|<code>boolean</code>
<code>string</code> - compcon_id(?)
|<code>flags</code> - GoldenPathHighlight.AUTO_CLEAR
|-
|<code>event_combat_set_objective</code>
|<code>number</code> - index of objective to change
<code>boolean</code> - is complete?
|<code>string</code> - objective text
<code>array</code> - [2,4] => "Search all zones! (2/4)"

<code>flags</code>
|-
|<code>event_combat_set_round_max</code>
|<code>number</code>
|
|-
|<code>event_combat_set_triggers_enabled</code>
|<code>string</code> - name of trigger group
<code>boolean</code>
|
|-
|<code>event_delay</code>
|<code>number</code> - milliseconds
|
|-
|<code>event_dialogue</code>
|<code>string</code> - conversation id
|<code>unit</code> - for dynamic text
<code>target_units</code> - for dynamic text
|-
|<code>event_dialogue_bark</code>
|<code>unit</code>
<code>string</code> - line id '''or''' raw text
|<code>target_units</code> - for dynamic text
<code>flags</code>
|-
|<code>event_dialogue_emoji</code>
|<code>unit</code>
<code>category</code> - Emoji.TYPE
|<code>number</code> - length to show in milliseconds
|-
|<code>event_dialogue_face</code>
|<code>unit</code>
<code>target_tiles</code> - tiles to look at
|
|-
|<code>event_gear_choose_and_use</code>
|<code>unit</code>
<code>gear</code>

<code>action</code>

<code>array</code> - Array[SpecificAction] - actions to pick from
|<code>boolean</code> - is overwatch?
<code>string</code> - variant action id if mandatory

<code>flags</code> - Action.FLAG

('''if''' Action.FLAG.TARGETS_ARE_MANDATORY:

<code>target_units</code> - mandatory targets

<code>target_tiles</code> - mandatory targets)
|-
|<code>event_map_block_add</code>
|<code>target_tiles</code>
<code>category</code> - block id (int)

<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_block_remove</code>
|<code>target_tiles</code>
<code>number</code> - elevation
|<code>flags</code> - EventMapBlockAdd.FLAG
|-
|<code>event_map_dangerous</code>
|<code>unit</code>
<code>category</code> - Lancer.DAMAGE_TYPE - type of damage to do on failure
|<code>resource</code> - MovementType
|-
|<code>event_map_doodad_add</code>
|<code>target_tiles</code>
<code>category</code> - doodad id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_doodad_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_effect</code>
|<code>string</code> - FXGroup id
|<code>target_tiles</code>
<code>target_units</code>
<code>boolean</code> - wait for effect to end
|-
|<code>event_map_setpiece_add</code>
|<code>target_tiles</code>
<code>category</code> - setpiece id
|<code>number</code> - rotation (0-3)
<code>flags</code>
|-
|<code>event_map_setpiece_remove</code>
|<code>target_tiles</code>
|
|-
|<code>event_map_set_water</code>
|<code>number</code> - elevation
|
|-
|<code>event_map_text</code>
|<code>string</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_map_weather_toggle</code>
|<code>string</code> - weather id
<code>boolean</code>
|
|-
|<code>event_music_play</code>
|<code>string</code> - fmod event path
|<code>flags</code>
|-
|<code>event_music_stop</code>
|
|
|-
|<code>event_round_end</code>
|
|
|-
|<code>event_round_set_next_faction</code>
|<code>category</code> - Faction.SIDE
|
|-
|<code>event_unit_attach</code>
|<code>unit</code>
<code>target_units</code>
<code>boolean</code> - attach or release
|
|-
|<code>event_unit_deploy</code>
|<code>resource</code> - UnitCore
<code>target_tiles</code>
|<code>number</code> - direction (0-3)
<code>flags</code> - EventUnitSpawn.FLAG
|-
|<code>event_unit_extract</code>
|<code>unit</code>
|<code>flags</code> - EventUnitExtract.FLAG
|-
|<code>event_unit_faction</code>
|<code>unit</code>
<code>category</code> - Faction.SIDE
|<code>flags</code> - flags[0] is Lancer.UNTIL
|-
|<code>event_unit_heal</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_mount</code>
|<code>unit</code>
<code>target_tiles</code>
|<code>flags</code>
|-
|<code>event_unit_overkill</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_overshield</code>
|<code>unit</code>
<code>number</code>
|
|-
|<code>event_unit_pick_move</code>
|<code>target_unit</code>
<code>resource</code> - MovementType
|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder
'''or'''
<code>number</code> - movement budget)
<code>array</code> - Array[Vector2i] - knockback origin tiles
<code>unit</code> - origin unit
<code>gear</code> - origin gear
<code>action</code> - origin action
|-
|<code>event_unit_rename</code>
|<code>unit</code>
<code>string</code>
<code>category</code> - FetcherNameType.WHICH_NAME
|
|-
|<code>event_unit_set_stat</code>
|<code>unit</code>
<code>category</code> - Statblock.PROP
<code>number</code>
|
|-
|<code>event_unit_sitrep_tag</code>
|<code>unit</code>
<code>string</code> - sitrep tag to add/remove
<code>boolean</code>
|
|-
|<code>event_unit_teleport</code>
|<code>unit</code>
<code>target_tiles</code>
|
|-
|<code>event_zone_equip</code>
|<code>string</code> - kit id
<code>array</code> - Array[ZoneCore]
|
|-
|<code>event_zone_launch</code>
|<code>array</code> - Array[ZoneCore]
<code>flags</code> - EventUnitSpawn.FLAG
|
|-
|<code>event_zone_reinforce</code>
|<code>string</code> - reinforcement group id or name
<code>number</code> - number of units to deploy
<code>array</code> - Array[ZoneCore]
|<code>flags</code> - EventZoneReinforce.FLAG
|-
|<code>event_zone_setup</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
<code>boolean</code> - is visible
|<code>string</code> - zone name
<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_guides</code>
|<code>array</code> - Array[ZoneCore]
|<code>flags</code> - Zone.GUIDE
|-
|<code>event_zone_set_name</code>
|<code>array</code> - Array[ZoneCore]
<code>string</code> - zone name
|
|-
|<code>event_zone_set_properties</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
<code>flags</code>
|<code>string</code> - zone name
|-
|<code>event_zone_set_type</code>
|<code>array</code> - Array[ZoneCore]
<code>category</code> - Zone.TYPE
|
|-
|<code>event_zone_set_visible</code>
|<code>array</code> - Array[ZoneCore]
<code>boolean</code> - is visible
|
|-
|event_zone_usable
|<code>array</code> - Array[ZoneCore]
<code>string</code> - name of action
<code>object</code> - desc of action (String)
|<code>target_units</code> - unit whitelist
<code>flags</code> - EventZoneUsable.FLAG
|}

===== Module Events =====
TODO
{| class="wikitable sortable"
!Event ID
!Required Context
!Optional Context
|-
|
|
|
|}

Events and Context

2026-07-27T15:22:51Z

GavstarB: formatting

Events and Context

2026-07-27T15:17:49Z

GavstarB: formatting

Events and Context

2026-07-27T15:12:15Z

GavstarB: updated events table (still WIP)

Events and Context

2026-07-27T11:51:58Z

GavstarB: formatting

Events and Context

2026-07-27T11:47:48Z

GavstarB: formatting

Events and Context

2026-07-27T11:45:39Z

GavstarB: formatting

Events and Context

2026-07-27T11:42:06Z

GavstarB: Added new Events and Context page (WIP)

The Muse

2026-07-25T11:14:17Z

GavstarB: /* Modding */ Added link to new Localization and Text Highlighting page

<strong>The Muse</strong> (aka the Lancer Tactics Wiki) is a compilation of editor documentation and guides for <strong>[https://lancertactics.com/ Lancer Tactics]</strong>, a video game adaptation of the [https://massifpress.com/lancer Lancer TTRPG] by Tom Bloom and Miguel Lopez-Hall. The in-universe concept of the Muse is from the [https://vexwerewolf.itch.io/in-golden-flame-act-1 In Golden Flame] module by Vex Werewolf.

== Modding ==
* [[Modding EULA]]
* [[Modding|Introduction to modding]]
* [[Modding Cookbook]]
* [[Basic Troubleshooting]]
* [[Fx Groups]]
* [[Localization and Text Highlighting]]
* [[Pixel Art]]
* [[Adding a new License]]

== Editors ==
* [[Module Editor]]
* [[Combat Editor Cookbook]]
* [[Editor Triggers|Editor Triggers List]]
* [[Playtesting|Playtesting tips]]

== Other ==
* [[Changes from the TTRPG]]

== External Links & Resources ==
* [https://wick.works/devlog/category/lancer-tactics Devlog at wick.works]
* [https://discord.com/invite/2t7Efg2Fbj Lancer Tactics Discord]
* [https://wick.itch.io/lancer-tactics/community itch.io forums]
* [https://wick.itch.io/lancer-tactics itch.io store page]
* [https://store.steampowered.com/app/4049810/Lancer_Tactics/ Wishlist on Steam]
* [https://mod.io/g/lancer-tactics Lancer Tactics on mod.io]
* [https://compcon.app/ COMP/CON]

''Lancer Tactics is not an official Lancer product; it is a third party work, and is not affiliated with Massif Press. Lancer Tactics is published via the Lancer Third Party License. Lancer is copyright Massif Press.''

Localization and Text Highlighting

2026-07-25T11:12:04Z

GavstarB: minor fomatting tweaks

== Localization ==
All text in Lancer Tactics is translated through Godot's [https://docs.godotengine.org/en/4.4/tutorials/assets_pipeline/importing_translations.html localization system]. In the modkit, the complete translations for the game can be found at <code>res://assets/localization/localizations.csv</code>. For mods, the <code>res://unpacked/<MOD_ID>/localization/localizations.csv</code> file will be generated automatically by the mod tool.

It looks something like this:
id,en,
mod.yourname-example.name,example,
The file may have any number of columns. The first column is the translation key and any subsequent columns are translations of the text for a particular language. The locale for each column is specified in the first row.

'''<big>Any time you make a change to this file, you must <code>Reimport</code> it for the changes to apply.</big>'''

Translation keys are generally made up of three parts: the prefix, the compcon id of the Resource (and any parent resources), and the suffix.

For mods, generally the prefixes we need to worry about are <code>frame.</code> for Frames and <code>gear.</code> for Kits.

The most common suffixes are:
{| class="wikitable"
!Suffix
!Meaning
|-
|<code>.name</code>
|The name of the Resource.
|-
|<code>.effect</code>
|For Kits, this is the main body of the tooltip.
|-
|<code>.flavor</code>
|Lore text for the Frame or Kit. For Kits, this is usually omitted entirely.
|-
|<code>.flavor.short</code>
|For Frames, this is the short description of the Frame which appears on the Licenses ring screen.
|-
|<code>.on_attack</code>
|For Kits with ActionAttacks, this displays any <code>On attack:</code> effects in the tooltip.
|-
|<code>.on_hit</code>
|For Kits with ActionAttacks, this displays any <code>On hit:</code> effects in the tooltip.
|-
|<code>.on_crit</code>
|For Kits with ActionAttacks, this displays any <code>On crit:</code> effects in the tooltip.
|-
|<code>.on_miss</code>
|For Kits with ActionAttacks, this displays any <code>On miss:</code> effects in the tooltip.
|}
For Actions, we use the <code>gear.</code> prefix and include the compcon id of the Kit before the compcon id of the Action.

===== Example Frame =====
id,en,
frame.mf_example.name,"Example",
frame.mf_example.flavor,"The Example frame was created by GMS to use as an example in their various pieces of documentation. It is unclear if any were ever constructed in reality.",
frame.mf_example.flavor.short,"Helpful Example",

===== Example Kit =====
id,en,
gear.ms_example.name,"Example Kit",
gear.ms_example.effect,"Does nothing.",

===== Example Kit (with an Action) =====
id,en,
gear.ms_example.name,"Example Kit",
gear.ms_example.action_example.name,"Example Action",
gear.ms_example.action_example.effect,"Does nothing.",

== Text Highlighting ==
Text in Lancer Tactics supports [https://docs.godotengine.org/en/stable/tutorials/ui/bbcode_in_richtextlabel.html bbcode formatting]. This means we can make text '''bold''' with <code>[b]text[/b]</code> and ''italic'' with <code>[i]text[/i]</code>.

The text may also contain keywords, formatted as <code>|keyword|</code>, which are highlighted in orange and display a tooltip explaining their meaning when hovered. The text highlighted with <code>||</code> may also contain a valid dice string such as <code>+2</code> or <code>1d6</code> either before or after the word.

The tooltip for a Kit may be displayed on hover by using <code>|Stabilize=gear.ms_stabilize|</code> where <code>Stabilize</code> is the string and <code>ms_stabilize</code> is the compcon id of the Kit. These will be colored green instead of orange.

====== Formatting Tips: ======

* Keywords in Lancer Tactics are always lowercase, with the exception of acronyms like <code>|HP|</code> and <code>|AP|</code>.
* The names of Actions, Kits and Deployables are capitalized. Where they cannot be given a green tooltip, they are '''bolded''' instead.
* Plurals of a keyword, such as <code>|protocols|</code>, are usually considered valid.
* Highlighting <code>|1 AP kinetic|</code> will not work, it must be split into <code>|1 AP| |kinetic|</code>.
* As <code>|ranged attack|</code> and <code>|melee attack|</code> are keywords, it is customary to highlight <code>|ranged| or |melee attack|</code> even though the first tooltip will not work.
* Although <code>|teleport|</code> and <code>|teleports|</code> work, <code>|teleported|</code> does not. Use <code>|teleport||ed|</code> instead.
* Modders often highlight <code>|efficient|</code> even though it is not a keyword in the base game.

===== Keywords =====
{| class="wikitable"
!Type
!Keywords
|-
|Actions
|<code><nowiki>|barrage|</nowiki></code>, <code><nowiki>|boost|</nowiki></code>, <code><nowiki>|free action|</nowiki></code>, <code><nowiki>|full action|</nowiki></code>, <code><nowiki>|grapple|</nowiki></code>, <code><nowiki>|invade|</nowiki></code>, <code><nowiki>|overcharge|</nowiki></code>, <code><nowiki>|overwatch|</nowiki></code>, <code><nowiki>|protocol|</nowiki></code>, <code><nowiki>|quick action|</nowiki></code>, <code><nowiki>|ram|</nowiki></code>, <code><nowiki>|reaction|</nowiki></code>, <code><nowiki>|tech|</nowiki></code>
|-
|AOEs
|<code><nowiki>|blast|</nowiki></code>, <code><nowiki>|burst|</nowiki></code>, <code><nowiki>|chain|</nowiki></code>, <code><nowiki>|cone|</nowiki></code>, <code><nowiki>|line|</nowiki></code>, <code><nowiki>|area|</nowiki></code>
|-
|Attacks
|<code><nowiki>|melee attack|</nowiki></code>, <code><nowiki>|ranged attack|</nowiki></code>, <code><nowiki>|tech attack|</nowiki></code>
|-
|Checks & Saves
|<code><nowiki>|check|</nowiki></code>, <code><nowiki>|save|</nowiki></code>, <code><nowiki>|agility save|</nowiki></code>, <code><nowiki>|engineering save|</nowiki></code>, <code><nowiki>|hull save|</nowiki></code>, <code><nowiki>|systems save|</nowiki></code>
|-
|Cover
|<code><nowiki>|cover|</nowiki></code>, <code><nowiki>|hard cover|</nowiki></code>, <code><nowiki>|soft cover|</nowiki></code>
|-
|Damage
|<code><nowiki>|burn|</nowiki></code>, <code><nowiki>|energy|</nowiki></code>, <code><nowiki>|explosive|</nowiki></code>, <code><nowiki>|heat|</nowiki></code>, <code><nowiki>|kinetic|</nowiki></code>
|-
|Gear
|<code><nowiki>|AI|</nowiki></code>, <code><nowiki>|deployable|</nowiki></code>, <code><nowiki>|drone|</nowiki></code>, <code><nowiki>|indestructible|</nowiki></code>, <code><nowiki>|limited|</nowiki></code>, <code><nowiki>|recharge {x}+|</nowiki></code>, <code><nowiki>|{x} heat (self)|</nowiki></code>, <code><nowiki>|shield|</nowiki></code>, <code><nowiki>|uncharged|</nowiki></code>, <code><nowiki>|unique|</nowiki></code>, <code><nowiki>|weapon mod|</nowiki></code>
|-
|HASE
|<code><nowiki>|agility|</nowiki></code>, <code><nowiki>|engineering|</nowiki></code>, <code><nowiki>|grit|</nowiki></code>, <code><nowiki>|hull|</nowiki></code>, <code><nowiki>|systems|</nowiki></code>
|-
|Stats
|<code><nowiki>|armor|</nowiki></code>, <code><nowiki>|e-defense|</nowiki></code>, <code><nowiki>|evasion|</nowiki></code>, <code><nowiki>|health|</nowiki></code>/<code><nowiki>|HP|</nowiki></code>, <code><nowiki>|heat cap|</nowiki></code>, <code><nowiki>|limited bonus|</nowiki></code>, <code><nowiki>|reactions|</nowiki></code>, <code><nowiki>|repair cap|</nowiki></code>, <code><nowiki>|save target|</nowiki></code>, <code><nowiki>|sensor range|</nowiki></code>/<code><nowiki>|sensors|</nowiki></code>, <code><nowiki>|size|</nowiki></code>, <code><nowiki>|speed|</nowiki></code>, <code><nowiki>|stress|</nowiki></code>, <code><nowiki>|structure|</nowiki></code>, <code><nowiki>|system points|</nowiki></code>/<code><nowiki>|SP|</nowiki></code>, <code><nowiki>|tech attack|</nowiki></code>
|-
|Statuses & Conditions
|<code><nowiki>|blinded|</nowiki></code>, <code><nowiki>|danger zone|</nowiki></code>, <code><nowiki>|dazed|</nowiki></code>, <code><nowiki>|disengaged|</nowiki></code>, <code><nowiki>|engaged|</nowiki></code>, <code><nowiki>|eva-equipped|</nowiki></code>, <code><nowiki>|exiled|</nowiki></code>, <code><nowiki>|exposed|</nowiki></code>, <code><nowiki>|flying|</nowiki></code>, <code><nowiki>|grappled|</nowiki></code>, <code><nowiki>|hidden|</nowiki></code>, <code><nowiki>|immobilized|</nowiki></code>, <code><nowiki>|impaired|</nowiki></code>, <code><nowiki>|intangible|</nowiki></code>, <code><nowiki>|invisible|</nowiki></code>, <code><nowiki>|invulnerable|</nowiki></code>, <code><nowiki>|jammed|</nowiki></code>, <code><nowiki>|lock on|</nowiki></code>, <code><nowiki>|prone|</nowiki></code>, <code><nowiki>|shredded|</nowiki></code>, <code><nowiki>|shut down|</nowiki></code>, <code><nowiki>|slowed|</nowiki></code>, <code><nowiki>|stunned|</nowiki></code>
|-
|Terms
|<code><nowiki>|accuracy|</nowiki></code>, <code><nowiki>|bonus damage|</nowiki></code>, <code><nowiki>|CORE Power|</nowiki></code>/<code><nowiki>|CP|</nowiki></code>, <code><nowiki>|critical hit|</nowiki></code>/<code><nowiki>|crit|</nowiki></code>, <code><nowiki>|dangerous terrain|</nowiki></code>, <code><nowiki>|difficult terrain|</nowiki></code>, <code><nowiki>|difficulty|</nowiki></code>, <code><nowiki>|engagement|</nowiki></code>, <code><nowiki>|fly|</nowiki></code>, <code><nowiki>|free space|</nowiki></code>/<code><nowiki>|free|</nowiki></code>, <code><nowiki>|full repair|</nowiki></code>, <code><nowiki>|immunity|</nowiki></code>, <code><nowiki>|invisibility|</nowiki></code>, <code><nowiki>|knockback|</nowiki></code>, <code><nowiki>|line of sight|</nowiki></code>, <code><nowiki>|movement|</nowiki></code>, <code><nowiki>|object|</nowiki></code>, <code><nowiki>|obstruction|</nowiki></code>, <code><nowiki>|overshield|</nowiki></code>, <code><nowiki>|range|</nowiki></code>, <code><nowiki>|reactor meltdown|</nowiki></code>/<code><nowiki>|meltdown|</nowiki></code>, <code><nowiki>|reserve|</nowiki></code>, <code><nowiki>|resistance|</nowiki></code>, <code><nowiki>|rest|</nowiki></code>, <code><nowiki>|skirmish|</nowiki></code>, <code><nowiki>|teleport|</nowiki></code>, <code><nowiki>|zero-g|</nowiki></code>
|-
|Weapons
|<code><nowiki>|accurate|</nowiki></code>, <code><nowiki>|armor-piercing|</nowiki></code>/<code><nowiki>|AP|</nowiki></code>, <code><nowiki>|arcing|</nowiki></code>, <code><nowiki>|attack bonus|</nowiki></code>, <code><nowiki>|auxiliary|</nowiki></code>/<code><nowiki>|aux|</nowiki></code>, <code><nowiki>|cannon|</nowiki></code>, <code><nowiki>|CQB|</nowiki></code>, <code><nowiki>|heavy|</nowiki></code>, <code><nowiki>|inaccurate|</nowiki></code>, <code><nowiki>|irreducible|</nowiki></code>, <code><nowiki>|launcher|</nowiki></code>, <code><nowiki>|loading|</nowiki></code>, <code><nowiki>|main|</nowiki></code>, <code><nowiki>|melee|</nowiki></code>, <code><nowiki>|nexus|</nowiki></code>, <code><nowiki>|ordnance|</nowiki></code>, <code><nowiki>|overkill|</nowiki></code>, <code><nowiki>|reliable|</nowiki></code>, <code><nowiki>|rifle|</nowiki></code>, <code><nowiki>|seeking|</nowiki></code>, <code><nowiki>|smart|</nowiki></code>, <code><nowiki>|superheavy|</nowiki></code>, <code><nowiki>|threat|</nowiki></code>, <code><nowiki>|thrown|</nowiki></code>, <code><nowiki>|unloaded|</nowiki></code>
|-
|Lore
|<code><nowiki>|NHP|</nowiki></code>, <code><nowiki>|General Massive Systems|</nowiki></code>/<code><nowiki>|GMS|</nowiki></code>, <code><nowiki>|Harrison Armory|</nowiki></code>/<code><nowiki>|HA|</nowiki></code>, <code><nowiki>|HORUS|</nowiki></code>, <code><nowiki>|IPS-Northstar|</nowiki></code>/<code><nowiki>|IPS-N|</nowiki></code>, <code><nowiki>|Smith-Shimano Corpro|</nowiki></code>/<code><nowiki>|SSC|</nowiki></code>
|}

===== Complete example - the Hecatoncheires =====
id,en,
"frame.mf_balor_alt_hecatoncheires.name","Hecatoncheires",
"frame.mf_balor_alt_hecatoncheires.flavor","Officially, the Hecatoncheires does not exist. Baronic...",
"frame.mf_balor_alt_hecatoncheires.flavor.short","Sneaky Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.name","MYRIOS Long-Leash Directed Greywash",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_deploy_razor_swarm.name","Deploy Razor Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_deploy_razor_swarm.effect","Deploy a [b]Razor Swarm[/b] to a valid |blast 1| area within |sensors| that contains no hostile characters. The Hecatoncheires may only have a single [b]Razor Swarm[/b] deployed at any one time. The [b]Razor Swarm[/b] persists until the end of the scene or until recalled or redeployed as a |quick action|.\nA [b]Razor Swarm[/b] is a |blast 1| area that provides |soft cover| to allied characters that are at least partially within the area. Hostile characters that start their turn at least partially within the area or move into it for the first time in a round take |2 burn|.\nA [b]Razor Swarm[/b] counts as a |drone| for the purposes of your and your allies' systems, talents, traits, and so on, but is not a character and is otherwise treated as a zone on the battlefield. It does not obstruct movement or cause |engagement|, and hostile characters cannot affect the [b]Razor Swarm[/b] in any way.",
"frame.dep_razor_swarm_hecatoncheires.name","Razor Swarm",
"gear.mt_razor_swarm_hecatoncheires.name","Razor Swarm",
"gear.mt_razor_swarm_hecatoncheires.effect","A [b]Razor Swarm[/b] is a |blast 1| area that provides |soft cover| to allied characters that are at least partially within the area. Hostile characters that start their turn at least partially within the area or move into it for the first time in a round take |2 burn|.\nA [b]Razor Swarm[/b] counts as a |drone| for the purposes of your and your allies' systems, talents, traits, and so on, but is not a character and is otherwise treated as a zone on the battlefield. It does not obstruct movement or cause |engagement|, and hostile characters cannot affect the [b]Razor Swarm[/b] in any way.",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_enrage_swarm.name","Enrage Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_enrage_swarm.effect","Each hostile character in one or more areas created by your |drones| takes |4 burn|. This action is |efficient| and will refund |1 CP| at the end of any scene in which this action was used.",
"gear.mt_dispersed_profile_hecatoncheires.name","Dispersed Profile",
"gear.mt_dispersed_profile_hecatoncheires.effect","When the Hecatoncheires is in |soft cover|, ranged attackers receive |+2 difficulty| instead of |+1 difficulty|.",
"gear.mt_smoke_and_mirrors_hecatoncheires.name","Smoke and Mirrors",
"gear.mt_smoke_and_mirrors_hecatoncheires.effect","The Hecatoncheires can always |Hide=gear.ms_hide| in an area of |soft cover|, regardless of |engagement| or enemy traits and systems.",
"gear.mt_panoptes_targeting_hecatoncheires.name","Panoptes Targeting",
"gear.mt_panoptes_targeting_hecatoncheires.effect","The Hecatoncheires' |smart| weapons ignore the |invisible| status of characters within |sensors|.",

Localization and Text Highlighting

2026-07-25T11:09:35Z

GavstarB: Added Localizations and Text Highlighting page.

== Localization ==
All text in Lancer Tactics is translated through Godot's [https://docs.godotengine.org/en/4.4/tutorials/assets_pipeline/importing_translations.html localization system]. In the modkit, the complete translations for the game can be found at <code>res://assets/localization/localizations.csv</code>. For mods, the <code>res://unpacked/<MOD_ID>/localization/localizations.csv</code> file will be generated automatically by the mod tool.

It looks something like this:
id,en,
mod.yourname-example.name,example,
The file may have any number of columns. The first column is the translation key and any subsequent columns are translations of the text for a particular language. The locale for each column is specified in the first row.

====== Any time you make a change to this file, you must <code>Reimport</code> it for the changes to apply. ======
Translation keys are generally made up of three parts: the prefix, the compcon id of the Resource (and any parent resources), and the suffix.

For mods, generally the prefixes we need to worry about are <code>frame.</code> for Frames and <code>gear.</code> for Kits.

The most common suffixes are:
{| class="wikitable"
!Suffix
!Meaning
|-
|<code>.name</code>
|The name of the Resource.
|-
|<code>.effect</code>
|For Kits, this is the main body of the tooltip.
|-
|<code>.flavor</code>
|Lore text for the Frame or Kit. For Kits, this is usually omitted entirely.
|-
|<code>.flavor.short</code>
|For Frames, this is the short description of the Frame which appears on the Licenses ring screen.
|-
|<code>.on_attack</code>
|For Kits with ActionAttacks, this displays any <code>On attack:</code> effects in the tooltip.
|-
|<code>.on_hit</code>
|For Kits with ActionAttacks, this displays any <code>On hit:</code> effects in the tooltip.
|-
|<code>.on_crit</code>
|For Kits with ActionAttacks, this displays any <code>On crit:</code> effects in the tooltip.
|-
|<code>.on_miss</code>
|For Kits with ActionAttacks, this displays any <code>On miss:</code> effects in the tooltip.
|}
For Actions, we use the <code>gear.</code> prefix and include the compcon id of the Kit before the compcon id of the Action.

===== Example Frame: =====
id,en,
frame.mf_example.name,"Example",
frame.mf_example.flavor,"The Example frame was created by GMS to use as an example in their various pieces of documentation. It is unclear if any were ever constructed in reality.",
frame.mf_example.flavor.short,"Helpful Example",

===== Example Kit: =====
id,en,
gear.ms_example.name,"Example Kit",
gear.ms_example.effect,"Does nothing.",

===== Example Kit (with an Action): =====
id,en,
gear.ms_example.name,"Example Kit",
gear.ms_example.action_example.name,"Example Action",
gear.ms_example.action_example.effect,"Does nothing.",

== Text Highlighting ==
Text in Lancer Tactics supports [https://docs.godotengine.org/en/stable/tutorials/ui/bbcode_in_richtextlabel.html bbcode formatting]. This means we can make text '''bold''' with <code>[b]text[/b]</code> and ''italic'' with <code>[i]text[/i]</code>.

The text may also contain keywords, formatted as <code>|keyword|</code>, which are highlighted in orange and display a tooltip explaining their meaning when hovered. The text highlighted with <code>||</code> may also contain a valid dice string such as <code>+2</code> or <code>1d6</code> either before or after the word.

The tooltip for a Kit may be displayed on hover by using <code>|Stabilize=gear.ms_stabilize|</code> where <code>Stabilize</code> is the string and <code>ms_stabilize</code> is the compcon id of the Kit. These will be colored green instead of orange.

====== Formatting Tips: ======

* Keywords in Lancer Tactics are always lowercase, with the exception of acronyms like <code>|HP|</code> and <code>|AP|</code>.
* The names of Actions, Kits and Deployables are capitalized. Where they cannot be given a green tooltip, they are '''bolded''' instead.
* Plurals of a keyword, such as <code>|protocols|</code>, are usually considered valid.
* Highlighting <code>|1 AP kinetic|</code> will not work, it must be split into <code>|1 AP| |kinetic|</code>.
* As <code>|ranged attack|</code> and <code>|melee attack|</code> are keywords, it is customary to highlight <code>|ranged| or |melee attack|</code> even though the first tooltip will not work.
* Although <code>|teleport|</code> and <code>|teleports|</code> work, <code>|teleported|</code> does not. Use <code>|teleport||ed|</code> instead.
* Modders often highlight <code>|efficient|</code> even though it is not a keyword in the base game.

====== Keywords: ======
{| class="wikitable"
!Type
!Keywords
|-
|Actions
|<code><nowiki>|barrage|</nowiki></code>, <code><nowiki>|boost|</nowiki></code>, <code><nowiki>|free action|</nowiki></code>, <code><nowiki>|full action|</nowiki></code>, <code><nowiki>|grapple|</nowiki></code>, <code><nowiki>|invade|</nowiki></code>, <code><nowiki>|overcharge|</nowiki></code>, <code><nowiki>|overwatch|</nowiki></code>, <code><nowiki>|protocol|</nowiki></code>, <code><nowiki>|quick action|</nowiki></code>, <code><nowiki>|ram|</nowiki></code>, <code><nowiki>|reaction|</nowiki></code>, <code><nowiki>|tech|</nowiki></code>
|-
|AOEs
|<code><nowiki>|blast|</nowiki></code>, <code><nowiki>|burst|</nowiki></code>, <code><nowiki>|chain|</nowiki></code>, <code><nowiki>|cone|</nowiki></code>, <code><nowiki>|line|</nowiki></code>, <code><nowiki>|area|</nowiki></code>
|-
|Attacks
|<code><nowiki>|melee attack|</nowiki></code>, <code><nowiki>|ranged attack|</nowiki></code>, <code><nowiki>|tech attack|</nowiki></code>
|-
|Checks & Saves
|<code><nowiki>|check|</nowiki></code>, <code><nowiki>|save|</nowiki></code>, <code><nowiki>|agility save|</nowiki></code>, <code><nowiki>|engineering save|</nowiki></code>, <code><nowiki>|hull save|</nowiki></code>, <code><nowiki>|systems save|</nowiki></code>
|-
|Cover
|<code><nowiki>|cover|</nowiki></code>, <code><nowiki>|hard cover|</nowiki></code>, <code><nowiki>|soft cover|</nowiki></code>
|-
|Damage
|<code><nowiki>|burn|</nowiki></code>, <code><nowiki>|energy|</nowiki></code>, <code><nowiki>|explosive|</nowiki></code>, <code><nowiki>|heat|</nowiki></code>, <code><nowiki>|kinetic|</nowiki></code>
|-
|Gear
|<code><nowiki>|AI|</nowiki></code>, <code><nowiki>|deployable|</nowiki></code>, <code><nowiki>|drone|</nowiki></code>, <code><nowiki>|indestructible|</nowiki></code>, <code><nowiki>|limited|</nowiki></code>, <code><nowiki>|recharge {x}+|</nowiki></code>, <code><nowiki>|{x} heat (self)|</nowiki></code>, <code><nowiki>|shield|</nowiki></code>, <code><nowiki>|uncharged|</nowiki></code>, <code><nowiki>|unique|</nowiki></code>, <code><nowiki>|weapon mod|</nowiki></code>
|-
|HASE
|<code><nowiki>|agility|</nowiki></code>, <code><nowiki>|engineering|</nowiki></code>, <code><nowiki>|grit|</nowiki></code>, <code><nowiki>|hull|</nowiki></code>, <code><nowiki>|systems|</nowiki></code>
|-
|Stats
|<code><nowiki>|armor|</nowiki></code>, <code><nowiki>|e-defense|</nowiki></code>, <code><nowiki>|evasion|</nowiki></code>, <code><nowiki>|health|</nowiki></code>/<code><nowiki>|HP|</nowiki></code>, <code><nowiki>|heat cap|</nowiki></code>, <code><nowiki>|limited bonus|</nowiki></code>, <code><nowiki>|reactions|</nowiki></code>, <code><nowiki>|repair cap|</nowiki></code>, <code><nowiki>|save target|</nowiki></code>, <code><nowiki>|sensor range|</nowiki></code>/<code><nowiki>|sensors|</nowiki></code>, <code><nowiki>|size|</nowiki></code>, <code><nowiki>|speed|</nowiki></code>, <code><nowiki>|stress|</nowiki></code>, <code><nowiki>|structure|</nowiki></code>, <code><nowiki>|system points|</nowiki></code>/<code><nowiki>|SP|</nowiki></code>, <code><nowiki>|tech attack|</nowiki></code>
|-
|Statuses & Conditions
|<code><nowiki>|blinded|</nowiki></code>, <code><nowiki>|danger zone|</nowiki></code>, <code><nowiki>|dazed|</nowiki></code>, <code><nowiki>|disengaged|</nowiki></code>, <code><nowiki>|engaged|</nowiki></code>, <code><nowiki>|eva-equipped|</nowiki></code>, <code><nowiki>|exiled|</nowiki></code>, <code><nowiki>|exposed|</nowiki></code>, <code><nowiki>|flying|</nowiki></code>, <code><nowiki>|grappled|</nowiki></code>, <code><nowiki>|hidden|</nowiki></code>, <code><nowiki>|immobilized|</nowiki></code>, <code><nowiki>|impaired|</nowiki></code>, <code><nowiki>|intangible|</nowiki></code>, <code><nowiki>|invisible|</nowiki></code>, <code><nowiki>|invulnerable|</nowiki></code>, <code><nowiki>|jammed|</nowiki></code>, <code><nowiki>|lock on|</nowiki></code>, <code><nowiki>|prone|</nowiki></code>, <code><nowiki>|shredded|</nowiki></code>, <code><nowiki>|shut down|</nowiki></code>, <code><nowiki>|slowed|</nowiki></code>, <code><nowiki>|stunned|</nowiki></code>
|-
|Terms
|<code><nowiki>|accuracy|</nowiki></code>, <code><nowiki>|bonus damage|</nowiki></code>, <code><nowiki>|CORE Power|</nowiki></code>/<code><nowiki>|CP|</nowiki></code>, <code><nowiki>|critical hit|</nowiki></code>/<code><nowiki>|crit|</nowiki></code>, <code><nowiki>|dangerous terrain|</nowiki></code>, <code><nowiki>|difficult terrain|</nowiki></code>, <code><nowiki>|difficulty|</nowiki></code>, <code><nowiki>|engagement|</nowiki></code>, <code><nowiki>|fly|</nowiki></code>, <code><nowiki>|free space|</nowiki></code>/<code><nowiki>|free|</nowiki></code>, <code><nowiki>|full repair|</nowiki></code>, <code><nowiki>|immunity|</nowiki></code>, <code><nowiki>|invisibility|</nowiki></code>, <code><nowiki>|knockback|</nowiki></code>, <code><nowiki>|line of sight|</nowiki></code>, <code><nowiki>|movement|</nowiki></code>, <code><nowiki>|object|</nowiki></code>, <code><nowiki>|obstruction|</nowiki></code>, <code><nowiki>|overshield|</nowiki></code>, <code><nowiki>|range|</nowiki></code>, <code><nowiki>|reactor meltdown|</nowiki></code>/<code><nowiki>|meltdown|</nowiki></code>, <code><nowiki>|reserve|</nowiki></code>, <code><nowiki>|resistance|</nowiki></code>, <code><nowiki>|rest|</nowiki></code>, <code><nowiki>|skirmish|</nowiki></code>, <code><nowiki>|teleport|</nowiki></code>, <code><nowiki>|zero-g|</nowiki></code>
|-
|Weapons
|<code><nowiki>|accurate|</nowiki></code>, <code><nowiki>|armor-piercing|</nowiki></code>/<code><nowiki>|AP|</nowiki></code>, <code><nowiki>|arcing|</nowiki></code>, <code><nowiki>|attack bonus|</nowiki></code>, <code><nowiki>|auxiliary|</nowiki></code>/<code><nowiki>|aux|</nowiki></code>, <code><nowiki>|cannon|</nowiki></code>, <code><nowiki>|CQB|</nowiki></code>, <code><nowiki>|heavy|</nowiki></code>, <code><nowiki>|inaccurate|</nowiki></code>, <code><nowiki>|irreducible|</nowiki></code>, <code><nowiki>|launcher|</nowiki></code>, <code><nowiki>|loading|</nowiki></code>, <code><nowiki>|main|</nowiki></code>, <code><nowiki>|melee|</nowiki></code>, <code><nowiki>|nexus|</nowiki></code>, <code><nowiki>|ordnance|</nowiki></code>, <code><nowiki>|overkill|</nowiki></code>, <code><nowiki>|reliable|</nowiki></code>, <code><nowiki>|rifle|</nowiki></code>, <code><nowiki>|seeking|</nowiki></code>, <code><nowiki>|smart|</nowiki></code>, <code><nowiki>|superheavy|</nowiki></code>, <code><nowiki>|threat|</nowiki></code>, <code><nowiki>|thrown|</nowiki></code>, <code><nowiki>|unloaded|</nowiki></code>
|-
|Lore
|<code><nowiki>|NHP|</nowiki></code>, <code><nowiki>|General Massive Systems|</nowiki></code>/<code><nowiki>|GMS|</nowiki></code>, <code><nowiki>|Harrison Armory|</nowiki></code>/<code><nowiki>|HA|</nowiki></code>, <code><nowiki>|HORUS|</nowiki></code>, <code><nowiki>|IPS-Northstar|</nowiki></code>/<code><nowiki>|IPS-N|</nowiki></code>, <code><nowiki>|Smith-Shimano Corpro|</nowiki></code>/<code><nowiki>|SSC|</nowiki></code>
|}

===== Complete example - the Hecatoncheires: =====
id,en,
"frame.mf_balor_alt_hecatoncheires.name","Hecatoncheires",
"frame.mf_balor_alt_hecatoncheires.flavor","Officially, the Hecatoncheires does not exist. Baronic...",
"frame.mf_balor_alt_hecatoncheires.flavor.short","Sneaky Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.name","MYRIOS Long-Leash Directed Greywash",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_deploy_razor_swarm.name","Deploy Razor Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_deploy_razor_swarm.effect","Deploy a [b]Razor Swarm[/b] to a valid |blast 1| area within |sensors| that contains no hostile characters. The Hecatoncheires may only have a single [b]Razor Swarm[/b] deployed at any one time. The [b]Razor Swarm[/b] persists until the end of the scene or until recalled or redeployed as a |quick action|.\nA [b]Razor Swarm[/b] is a |blast 1| area that provides |soft cover| to allied characters that are at least partially within the area. Hostile characters that start their turn at least partially within the area or move into it for the first time in a round take |2 burn|.\nA [b]Razor Swarm[/b] counts as a |drone| for the purposes of your and your allies' systems, talents, traits, and so on, but is not a character and is otherwise treated as a zone on the battlefield. It does not obstruct movement or cause |engagement|, and hostile characters cannot affect the [b]Razor Swarm[/b] in any way.",
"frame.dep_razor_swarm_hecatoncheires.name","Razor Swarm",
"gear.mt_razor_swarm_hecatoncheires.name","Razor Swarm",
"gear.mt_razor_swarm_hecatoncheires.effect","A [b]Razor Swarm[/b] is a |blast 1| area that provides |soft cover| to allied characters that are at least partially within the area. Hostile characters that start their turn at least partially within the area or move into it for the first time in a round take |2 burn|.\nA [b]Razor Swarm[/b] counts as a |drone| for the purposes of your and your allies' systems, talents, traits, and so on, but is not a character and is otherwise treated as a zone on the battlefield. It does not obstruct movement or cause |engagement|, and hostile characters cannot affect the [b]Razor Swarm[/b] in any way.",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_enrage_swarm.name","Enrage Swarm",
"gear.cp_myrios_long_leash_directed_greywash_hecatoncheires.action_enrage_swarm.effect","Each hostile character in one or more areas created by your |drones| takes |4 burn|. This action is |efficient| and will refund |1 CP| at the end of any scene in which this action was used.",
"gear.mt_dispersed_profile_hecatoncheires.name","Dispersed Profile",
"gear.mt_dispersed_profile_hecatoncheires.effect","When the Hecatoncheires is in |soft cover|, ranged attackers receive |+2 difficulty| instead of |+1 difficulty|.",
"gear.mt_smoke_and_mirrors_hecatoncheires.name","Smoke and Mirrors",
"gear.mt_smoke_and_mirrors_hecatoncheires.effect","The Hecatoncheires can always |Hide=gear.ms_hide| in an area of |soft cover|, regardless of |engagement| or enemy traits and systems.",
"gear.mt_panoptes_targeting_hecatoncheires.name","Panoptes Targeting",
"gear.mt_panoptes_targeting_hecatoncheires.effect","The Hecatoncheires' |smart| weapons ignore the |invisible| status of characters within |sensors|.",

File:Screenshot from 2026-07-25 09-13-21.png

2026-07-25T08:16:28Z

GavstarB:

id,en
mod.yourname-example.name,example,