From dac97826f7d0c9b9135c1a08c4d5f16b61494bd1 Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Wed, 26 Aug 2015 10:58:51 +0200
Subject: Renamed output directory to Server
---
Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua | 33 +++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua
(limited to 'Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua')
diff --git a/Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua b/Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua
new file mode 100644
index 000000000..e2bd1c940
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnSpawningEntity.lua
@@ -0,0 +1,33 @@
+return
+{
+ HOOK_SPAWNING_ENTITY =
+ {
+ CalledWhen = "Before an entity is spawned in the world.",
+ DefaultFnName = "OnSpawningEntity", -- also used as pagename
+ Desc = [[
+ This hook is called before the server spawns an {{cEntity|entity}}. The plugin can either modify the
+ entity before it is spawned, or disable the spawning altogether. You can't disable the spawning if the
+ entity is a player. If the entity spawning is a monster, the {{OnSpawningMonster|HOOK_SPAWNING_MONSTER}}
+ hook is called before this hook.
+
+ See also the {{OnSpawnedEntity|HOOK_SPAWNED_ENTITY}} hook for a similar hook called after the
+ entity is spawned.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world in which the entity will spawn" },
+ { Name = "Entity", Type = "{{cEntity}} descentant", Notes = "The entity that will spawn" },
+ },
+ Returns = [[
+ If the function returns false or no value, the next plugin's callback is called. Finally, the server
+ spawns the entity with whatever parameters have been set on the {{cEntity}} object by the callbacks.
+ If the function returns true, no other callback is called for this event and the entity is not
+ spawned.
+ ]],
+ }, -- HOOK_SPAWNING_ENTITY
+}
+
+
+
+
+
--
cgit v1.2.3