d9dc241e6f
All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
33 lines
1.2 KiB
Lua
33 lines
1.2 KiB
Lua
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. If the entity spawning is a
|
|
monster, the {{OnSpawningMonster|HOOK_SPAWNING_MONSTER}} hook is called before this hook.</p>
|
|
<p>
|
|
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
|
|
}
|
|
|
|
|
|
|
|
|
|
|