Module hoggit.spawner
spawner.lua Spawning utilities for H.O.G.G.I.T.
Framework
Functions
| Spawn (self) | Spawns a copy of the "template" group in the mission editor Spawns the group at the same location and with the same parameters as the 'template' in the mission editor. |
| SpawnAtPoint (self, point) | Same as 'Spawn', but takes an SSE Vec2 (table with an X and Y keys) |
| SpawnInZone (self, zoneName) | Same as 'Spawn' but takes a zone name defined in the mission editor |
| OnSpawnGroup (self, f, args) | Add a function with arguments to be called when this Spawner actually spawns a unit |
| HOGGIT.SetupDefaultSpawners () | Setup the default table of spawners, one for every group in the .miz |
Functions
- Spawn (self)
-
Spawns a copy of the "template" group in the mission editor
Spawns the group at the same location and with the same parameters as the 'template' in the mission editor.
Parameters:
- self HOGGIT.Spawner object
Returns:
-
Group
- SpawnAtPoint (self, point)
-
Same as 'Spawn', but takes an SSE Vec2 (table with an X and Y keys)
Parameters:
- self HOGGIT.Spawner object
- point Vec2
Returns:
-
Group
- SpawnInZone (self, zoneName)
-
Same as 'Spawn' but takes a zone name defined in the mission editor
Parameters:
- self HOGGIT.Spawner object
- zoneName Name of a zone that's defined in the mission editor
Returns:
-
Group
- OnSpawnGroup (self, f, args)
-
Add a function with arguments to be called when this Spawner actually spawns a unit
Parameters:
- self HOGGIT.Spawner
- f the function to be called, always called with spawned group as first param
- args table of additional arguments that the callback function will be called with
- HOGGIT.SetupDefaultSpawners ()
- Setup the default table of spawners, one for every group in the .miz