Module hook

Integrates the hook-sys library into EmptyEpsilon, registering relevant events automatically.

For documentation on how to call the library, see hook-sys.

Modules targeting this library that do not use predefined entity hooks should import hook-sys and specify the hooks they require, to allow them to be used in scripts that do not wish to integrate hook.

Global hooks

init() Triggered on scenario initialisation.
update(delta) Triggered on scenario update.
newPlayerShip(ship) Triggered when a player ship is created.
probeLaunch(ship, probe) Triggered when a scan probe is launched from any ship.

Entity hooks

destroyed(entity) Triggered when an entity is removed from the game by any means.
destruction(entity) Triggered when an entity is destroyed by damage.
expiration(entity) Triggered when a scan probe expires.


Global hooks

init()
Triggered on scenario initialisation.
update(delta)
Triggered on scenario update.

Parameters:

  • delta number
newPlayerShip(ship)
Triggered when a player ship is created.

Parameters:

  • ship PlayerSpaceship
probeLaunch(ship, probe)
Triggered when a scan probe is launched from any ship.

Parameters:

  • ship PlayerSpaceship
  • probe ScanProbe

Entity hooks

destroyed(entity)
Triggered when an entity is removed from the game by any means.

Parameters:

  • entity entity
destruction(entity)
Triggered when an entity is destroyed by damage.

Parameters:

  • entity entity
expiration(entity)
Triggered when a scan probe expires.

Parameters:

  • entity entity
generated by LDoc 1.5.0