Added OnEntityChangeWorld.lua and OnEntityChangedWorld.lua hooks to APIDump
This commit is contained in:
parent
4d4d1e9c69
commit
9aced8cd85
29
MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
Normal file
29
MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
Normal file
@ -0,0 +1,29 @@
|
||||
return
|
||||
{
|
||||
HOOK_ENTITY_CHANGE_WORLD =
|
||||
{
|
||||
CalledWhen = "Before a entity is changing the world.",
|
||||
DefaultFnName = "OnEntityChangeWorld", -- also used as pagename
|
||||
Desc = [[
|
||||
This hook is called before the server moves the {{cEntity|entity}} to the given world. Plugins may
|
||||
refuse the changing of the entity to the new world.<p>
|
||||
See also the {{OnEntityChangedWorld|HOOK_ENTITY_CHANGED_WORLD}} hook for a similar hook is called after the
|
||||
entity has been moved to the world.
|
||||
]],
|
||||
Params =
|
||||
{
|
||||
{ Name = "Entity", Type = "{{cEntity}}", Notes = "The entity that wants to change the world" },
|
||||
{ Name = "World", Type = "{{cWorld}}", Notes = "The world to which the entity wants to change" },
|
||||
},
|
||||
Returns = [[
|
||||
If the function returns false or no value, the next plugin's callback is called. If the function
|
||||
returns true, no other callback is called for this event and the change of the entity to the world is
|
||||
cancelled.
|
||||
]],
|
||||
}, -- HOOK_ENTITY_CHANGE_WORLD
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
28
MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua
Normal file
28
MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua
Normal file
@ -0,0 +1,28 @@
|
||||
return
|
||||
{
|
||||
HOOK_ENTITY_CHANGED_WORLD =
|
||||
{
|
||||
CalledWhen = "After a entity has changed the world.",
|
||||
DefaultFnName = "OnEntityChangedWorld", -- also used as pagename
|
||||
Desc = [[
|
||||
This hook is called after the server has moved the {{cEntity|entity}} to the given world. This is an information-only
|
||||
callback, the entity is already in the new world.<p>
|
||||
See also the {{OnEntityChangeWorld|HOOK_ENTITY_CHANGE_WORLD}} hook for a similar hook called before the
|
||||
entity is moved to the new world.
|
||||
]],
|
||||
Params =
|
||||
{
|
||||
{ Name = "Entity", Type = "{{cEntity}}", Notes = "The entity that has changed the world" },
|
||||
{ Name = "World", Type = "{{cWorld}}", Notes = "The world from which the entity has come" },
|
||||
},
|
||||
Returns = [[
|
||||
If the function returns false or no value, the next plugin's callback is called. If the function
|
||||
returns true, no other callback is called for this event.
|
||||
]],
|
||||
}, -- HOOK_ENTITY_CHANGED_WORLD
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user