Module escort
Library for dealing with escorts in missions.
Functions
init (ships[, params]) | Initializes the library by setting all the necessary hooks. |
exit () | Cleans up the escort framework when done, eliminating all hooks. |
num_alive () | Gets the number of escorts that are still alive. |
pilots () | Gets the list of pilots. |
setDest (dest, success[, failure]) | Sets the destination of the |
spawn (pos) | Spawns the escorts at location. |
Functions
- init (ships[, params])
-
Initializes the library by setting all the necessary hooks.
Parameters:
- exit ()
- Cleans up the escort framework when done, eliminating all hooks.
- num_alive ()
-
Gets the number of escorts that are still alive.
Returns:
-
number
Number of escorts still alive.
- pilots ()
-
Gets the list of pilots.
Returns:
-
table
Table containing the existing pilots. The first will be the leader.
- setDest (dest, success[, failure])
-
Sets the destination of the
Parameters:
- spawn (pos)
-
Spawns the escorts at location. This can be useful at the beginning if you want them to jump in or take of while in space. It is handled automatically when the player takes off or jumps into a system.
Parameters:
- pos Vector, Spob or System Position to spawn the fleet at. The argument is directly passed to pilot.add.
Returns:
-
table Table of newly created pilots.