Lua functions

GetCanGate

Registered in this checkout as EQ2Emu_lua_GetCanGate; implementation found at WorldServer/Lua/LuaFunctions.cpp:12933.

Historical signature: GetCanGate(spawn)

Parameter and behavior details in the historical explanation are under review against the current implementation.

Function: GetCanGate(spawn)

Description: Checks if the Spawn is allowed to use Gate spells in this zone or area.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

Returns: Returns UINT32 1 if you can gate, otherwise 0.

Checked example

Active call in a local runtime Lua script. Argument count matches current fixed C++ readers. This is a contextual call pattern, not a tested standalone script.

if(GetCanGate(Caster) == 1)

Evidence: server/Spells/Commoner/CalltoHome.lua:14; binding EQ2Emu_lua_GetCanGate.

Current registration: WorldServer/Lua/LuaInterface.cpp. Historical explanation: EQ2Emu Lua documentation.