wiki:Hooks

Version 2 (modified by Alloc, 8 years ago) (diff)

--

Hooks are a way to add additional behaviour to the scripts. They are basically custom scripts that are called upon specific events. For example one could define a hook which is called on player connects and then send a message in the in-game chat to greet the new player.

All hooks have to executable files in SDTD_BASE/<name of hook>/<any name>.sh.

If you think a hook for another event could be interesting please create a ticket or contact me.

Currently the following hooks are defined:

  • playerConnect
    • Called after a player has connected
    • Passed parameters:
      1. Instance name
      2. Player ID
      3. Entity ID
      4. Nickname
      5. Steam ID
  • playerDisconnect
    • Called after player has disconnected
    • Passed parameters:
      1. Instance name
      2. Player ID
      3. Entity ID
      4. Nickname
      5. Steam ID
  • serverPreStart
    • Called before an instance is started
    • Passed parameters:
      1. Instance name
  • serverPostStart
    • Called after an instance was started
    • Passed parameters:
      1. Instance name
  • serverPreStop
    • Called before an instance is stopped
    • Passed parameters:
      1. Instance name
  • serverPostStop
    • Called after an instance was stopped
    • Passed parameters:
      1. Instance name

Attachments (3)

Download all attachments as: .zip