Changes between Initial Version and Version 1 of Hooks

Timestamp:

26.05.2014 20:10:56 (10 years ago)

Author:

Alloc

Comment:

--

Hooks

@@ +1 @@
+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''.
+
+Currently the following hooks are defined:
+
+* playerConnect
+  * Called after a player has connected
+  * Passed parameters:
+    1. Instance name
+    1. Player ID
+    1. Entity ID
+    1. Nickname
+    1. Steam ID
+* playerDisconnect
+  * Called after player has disconnected
+  * Passed parameters:
+    1. Instance name
+    1. Player ID
+    1. Entity ID
+    1. Nickname
+    1. 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