Differences

This shows you the differences between two versions of the page.

--- tmf:wavespawner [2016/07/26 09:20] – [Wave spawner] head
+++ tmf:wavespawner [2025/08/03 14:24] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Wave spawner ======
 [[#headless client support|{{:tmf:hcicon.png}}]] [[#trigger support|{{:tmf:triggericon.png}}]]
-The wave spawner is a powerful tool for a wide variety of reason.
+The wave spawner is a powerful tool for a wide variety of reason. Any units that are synced to the wave spawner will be replicated when the wave spawner activates. When the mission loads they will be deleted and data on them stored (loadouts and waypoints).
 The wave spawner works with triggers or without.
@@ Line 21: / Line 22: @@
 {{:tmf:pcpupax.png|}}
+=====  API - Event handler =====
+==== On wave spawn event ====
+You can add an event handler via the TMF function //tmf_ai_fnc_addWaveHandler// . The event handler is executed everytime a wave is spawned. This code can be placed on the init box of the wave spawner module.
+The parameters passed to the event handler is an array consisting of: [wave_index,array of groups]
+Example 1: Set all spawned units to move fast and free to engage any enemies. Perhaps for spawned reinforcements.
+<code cpp>
+[this,{
+    private _groups = _this select 1;
+    {
+        _x setBehaviour "AWARE";
+        _x setCombatMode "RED";
+        _x setSpeedMode "FULL";
+    } forEach _groups;
+}] call tmf_ai_fnc_addWaveHandler;
+</code>
+Example 2: Handle the output in a seperately defined function.
+<code cpp>
+[this,my_custom_function] call tmf_ai_fnc_addWaveHandler;
+</code>