Events and Context - Revision history

GavstarB: formatting

2026-07-27T17:49:48Z

formatting

← Older revision		Revision as of 17:49, 27 July 2026
Line 17:		Line 17:
	• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.POST</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>		• 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:		* Run child events:
	<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.		<blockquote>• These are events queued to the EventCore with <code>event.queue_event()</code>.

GavstarB: formatting

2026-07-27T17:20:48Z

formatting

← Older revision		Revision as of 17:20, 27 July 2026
Line 698:		Line 698:
	\|		\|
	\|-		\|-
	\|event_zone_usable		\|<code>event_zone_usable</code>
	\|<code>array</code> - Array[ZoneCore]		\|<code>array</code> - Array[ZoneCore]
	<code>string</code> - name of action		<code>string</code> - name of action

GavstarB: formatting

2026-07-27T17:19:09Z

formatting

← Older revision		Revision as of 17:19, 27 July 2026
Line 235:		Line 235:
	\|<code>unit</code>		\|<code>unit</code>
	<code>string</code> - kit id		<code>string</code> - kit id

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

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

	<code>gear</code>		<code>gear</code>

	<code>action</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		\|executes an <code>event_gear_activate</code> which in turn runs <code>unit_action</code> reactions with a context matching this event
Line 246:		Line 250:
	\|<code>unit</code>		\|<code>unit</code>
	<code>category</code>		<code>category</code>

	<code>flags</code>		<code>flags</code>
	\|<code>string</code> - persistent id of source gear		\|<code>string</code> - persistent id of source gear
Line 295:		Line 300:
	\|<code>unit</code>		\|<code>unit</code>
	<code>target_tiles</code> - tile collided with		<code>target_tiles</code> - tile collided with

	<code>event</code>		<code>event</code>
	\|		\|
Line 368:		Line 374:
	\|<code>unit</code> - origin unit		\|<code>unit</code> - origin unit
	<code>gear</code> - origin gear		<code>gear</code> - origin gear

	<code>action</code> - origin action		<code>action</code> - origin action

	<code>string</code> - combat state key for success boolean to be saved to		<code>string</code> - combat state key for success boolean to be saved to
	\|<code>forced_save</code>		\|<code>forced_save</code>
Line 425:		Line 433:
	<code>boolean</code> - is complete?		<code>boolean</code> - is complete?
	\|<code>string</code> - objective text		\|<code>string</code> - objective text
	<code>array</code> - [2,4] => "Search all zones! (2/4)"		<code>array</code> - [2,4] -> "Search all zones! (2/4)"

	<code>flags</code>		<code>flags</code>
Line 512:		Line 520:
	\|<code>target_tiles</code>		\|<code>target_tiles</code>
	<code>target_units</code>		<code>target_units</code>

	<code>boolean</code> - wait for effect to end		<code>boolean</code> - wait for effect to end
	\|-		\|-
Line 557:		Line 566:
	\|<code>unit</code>		\|<code>unit</code>
	<code>target_units</code>		<code>target_units</code>

	<code>boolean</code> - attach or release		<code>boolean</code> - attach or release
	\|		\|
Line 600:		Line 610:
	\|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder		\|(<code>target_tiles</code> - Array[Vector2i] - tiles for Pathfinder
	'''or'''		'''or'''

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

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

	<code>unit</code> - origin unit		<code>unit</code> - origin unit

	<code>gear</code> - origin gear		<code>gear</code> - origin gear

	<code>action</code> - origin action		<code>action</code> - origin action
	\|-		\|-
Line 609:		Line 624:
	\|<code>unit</code>		\|<code>unit</code>
	<code>string</code>		<code>string</code>

	<code>category</code> - FetcherNameType.WHICH_NAME		<code>category</code> - FetcherNameType.WHICH_NAME
	\|		\|
Line 615:		Line 631:
	\|<code>unit</code>		\|<code>unit</code>
	<code>category</code> - Statblock.PROP		<code>category</code> - Statblock.PROP

	<code>number</code>		<code>number</code>
	\|		\|
Line 621:		Line 638:
	\|<code>unit</code>		\|<code>unit</code>
	<code>string</code> - sitrep tag to add/remove		<code>string</code> - sitrep tag to add/remove

	<code>boolean</code>		<code>boolean</code>
	\|		\|
Line 642:		Line 660:
	\|<code>string</code> - reinforcement group id or name		\|<code>string</code> - reinforcement group id or name
	<code>number</code> - number of units to deploy		<code>number</code> - number of units to deploy

	<code>array</code> - Array[ZoneCore]		<code>array</code> - Array[ZoneCore]
	\|<code>flags</code> - EventZoneReinforce.FLAG		\|<code>flags</code> - EventZoneReinforce.FLAG
Line 648:		Line 667:
	\|<code>array</code> - Array[ZoneCore]		\|<code>array</code> - Array[ZoneCore]
	<code>category</code> - Zone.TYPE		<code>category</code> - Zone.TYPE

	<code>boolean</code> - is visible		<code>boolean</code> - is visible
	\|<code>string</code> - zone name		\|<code>string</code> - zone name
Line 664:		Line 684:
	\|<code>array</code> - Array[ZoneCore]		\|<code>array</code> - Array[ZoneCore]
	<code>category</code> - Zone.TYPE		<code>category</code> - Zone.TYPE

	<code>flags</code>		<code>flags</code>
	\|<code>string</code> - zone name		\|<code>string</code> - zone name
Line 680:		Line 701:
	\|<code>array</code> - Array[ZoneCore]		\|<code>array</code> - Array[ZoneCore]
	<code>string</code> - name of action		<code>string</code> - name of action

	<code>object</code> - desc of action (String)		<code>object</code> - desc of action (String)
	\|<code>target_units</code> - unit whitelist		\|<code>target_units</code> - unit whitelist

GavstarB: finished first two event types table

2026-07-27T17:14:35Z

finished first two event types table

Show changes

GavstarB: formatting

2026-07-27T15:22:51Z

formatting

← Older revision		Revision as of 15:22, 27 July 2026
Line 2:		Line 2:
	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>.		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>.

	~~The execution sequence~~ for ~~running a particular event is:~~		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:		* 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>.		<blockquote>• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.
Line 22:		Line 23:
	• The child events are ordered according to their priority (low to high).		• 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>~~TODO - provide an example~~		• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>

	~~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).~~

	== Context ==		== 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.		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.

GavstarB: formatting

2026-07-27T15:17:49Z

formatting

← Older revision		Revision as of 15:17, 27 July 2026
Line 170:		Line 170:
	\|<code>number</code>		\|<code>number</code>
	<code>boolean</code>		<code>boolean</code>

	<code>unit</code>		<code>unit</code>

	<code>object</code>		<code>object</code>

	<code>array</code> - if given, emits the signal more than once for each item in the array		<code>array</code> - if given, emits the signal more than once for each item in the array
	\|<code>trigger_signal</code>		\|<code>trigger_signal</code>
Line 178:		Line 181:
	\|<code>unit</code>		\|<code>unit</code>
	<code>gear</code>		<code>gear</code>

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

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

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

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

	<code>string</code> - id of variant Action to be used		<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>unit_action</code> - generates a fake Context matching that of <code>event_unit_action</code>. Context cannot be modified by <code>PRE</code> events
Line 197:		Line 205:
	\|<code>unit</code>		\|<code>unit</code>
	(<code>gear</code>		(<code>gear</code>

	'''and/or'''		'''and/or'''

	<code>array</code> - Array[GearCore])		<code>array</code> - Array[GearCore])
	\|		\|
Line 207:		Line 217:
	\|<code>flags</code> - EventMapDamage.FLAG		\|<code>flags</code> - EventMapDamage.FLAG
	<code>object</code> - elevation to destroy down to (int)		<code>object</code> - elevation to destroy down to (int)

	<code>boolean</code> - set to true if terrain got destroyed		<code>boolean</code> - set to true if terrain got destroyed
	\|<code>terrain_damage</code>		\|<code>terrain_damage</code>
Line 223:		Line 234:
	\|<code>target_unit</code> - attacked unit		\|<code>target_unit</code> - attacked unit
	<code>unit</code> - attacking unit		<code>unit</code> - attacking unit

	<code>gear</code>		<code>gear</code>

	<code>action</code>		<code>action</code>

	<code>resource</code> - DeclaredAttackSummary		<code>resource</code> - DeclaredAttackSummary

	<code>event</code> - <code>event_unit_attack_declared</code>		<code>event</code> - <code>event_unit_attack_declared</code>
	\|<code>flags</code> - Action.FLAG		\|<code>flags</code> - Action.FLAG
Line 233:		Line 248:
	\|<code>unit</code>		\|<code>unit</code>
	<code>gear</code>		<code>gear</code>

	<code>action</code>		<code>action</code>

	<code>resource</code> - DeclaredAttackSummary		<code>resource</code> - DeclaredAttackSummary
	\|		\|
Line 246:		Line 263:
	\|<code>unit</code>		\|<code>unit</code>
	<code>number</code>		<code>number</code>
	\|<code>category</code> - Lancer.DAMAGE_TYPE, default kinetic		\|<code>category</code> - Lancer.DAMAGE_TYPE - default kinetic
	<code>object</code> - AttackRoll		<code>object</code> - AttackRoll

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

	<code>target_unit</code> - attacker		<code>target_unit</code> - attacker

	<code>gear</code> - attacker gear		<code>gear</code> - attacker gear

	<code>action</code> - attacker Action		<code>action</code> - attacker Action
	\|<code>damage</code>		\|<code>damage</code>
Line 257:		Line 278:
	\|<code>unit</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		(<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'''		'''or'''

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

	<code>object</code> - SpecificAction which caused the move		<code>object</code> - SpecificAction which caused the move
	\|<code>step</code>		\|<code>step</code>
Line 275:		Line 299:
	\|<code>buff</code>		\|<code>buff</code>
	<code>unit</code> - the unit the buff is applied to.		<code>unit</code> - the unit the buff is applied to.

	<code>event</code> - the event which triggered the activation.		<code>event</code> - the event which triggered the activation.
	\|		\|
Line 301:		Line 326:
	\|<code>string</code> - objective text		\|<code>string</code> - objective text
	<code>array</code> - [2,4] => "Search all zones! (2/4)"		<code>array</code> - [2,4] => "Search all zones! (2/4)"

	<code>flags</code>		<code>flags</code>
	\|-		\|-
Line 340:		Line 366:
	\|<code>unit</code>		\|<code>unit</code>
	<code>gear</code>		<code>gear</code>

	<code>action</code>		<code>action</code>

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

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

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

	<code>target_units</code> - mandatory targets		<code>target_units</code> - mandatory targets

	<code>target_tiles</code> - mandatory targets)		<code>target_tiles</code> - mandatory targets)
	\|-		\|-
Line 352:		Line 384:
	\|<code>target_tiles</code>		\|<code>target_tiles</code>
	<code>category</code> - block id (int)		<code>category</code> - block id (int)

	<code>number</code> - elevation		<code>number</code> - elevation
	\|<code>flags</code> - EventMapBlockAdd.FLAG		\|<code>flags</code> - EventMapBlockAdd.FLAG

GavstarB: updated events table (still WIP)

2026-07-27T15:12:15Z

updated events table (still WIP)

Show changes

GavstarB: formatting

2026-07-27T11:51:58Z

formatting

← Older revision		Revision as of 11:51, 27 July 2026
Line 5:		Line 5:

	* Run the <code>execute_preblock()</code> function for the event's EventBase:		* Run the <code>execute_preblock()</code> function for the event's EventBase:
	• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.		<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.		• 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.		* 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:		* Run the <code>execute()</code> function for the event's EventBase:
	• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).		<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.		• 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:		* Run child events:
	• These are events queued to the EventCore with <code>event.queue_event()</code>.		<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~~.		• The child events are ordered according to their priority (low to high).

	TODO - provide an example		• Loop through the child events and run the whole execution sequence for child event in turn.</blockquote>TODO - provide an example

	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).		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).

GavstarB: formatting

2026-07-27T11:47:48Z

formatting

GavstarB: formatting

2026-07-27T11:45:39Z

formatting

← Older revision		Revision as of 11:45, 27 July 2026
Line 4:		Line 4:
	The execution sequence for running a particular event is:		The execution sequence for running a particular event is:

	* Run the <code>execute_preblock()</code> function for the event's EventBase: • 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.		* Run the <code>execute_preblock()</code> function for the event's EventBase:
			• 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.
	* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.		* 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: • 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.~~P</code><code>OST~~</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.		* Run the <code>execute()</code> function for the event's EventBase:
	* Run child events: • 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.		• 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.
			* Run child events:
			• 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.

	TODO - provide an example		TODO - provide an example
Line 14:		Line 23:

	== Context ==		== 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.~~</code> <code>~~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.		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.

	The Context objects contains the following variables:		The Context objects contains the following variables:

← Older revision		Revision as of 11:47, 27 July 2026
Line 5:		Line 5:

	* Run the <code>execute_preblock()</code> function for the event's EventBase:		* Run the <code>execute_preblock()</code> function for the event's EventBase:
	• For events which can be reacted to, fetch the events for every reaction with timing <code>ReactionBus.TIMING.PRE</code>.		• 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).		• 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.		• Loop through the reaction events and run the whole execution sequence for each reaction event in turn.
	* If the event is aborted (<code>event.aborted == true</code>), or the Context object does not contain the required data, execution stops here.		* 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:		* Run the <code>execute()</code> function for the event's EventBase:
	• Executes any functionality the event has (for example, clearing heat for an <code>event_unit_cool</code>).		• 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>.		• 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.		• 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.
	* Run child events:		* Run child events:
	• These are events queued to the EventCore with <code>event.queue_event()</code>.		• 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).		• 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.		• Loop through the child events and run the whole execution sequence for child event in turn.

	TODO - provide an example		TODO - provide an example