Lua functions

SetBotAccessMode

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

Historical signature: SetBotAccessMode(…) via current binding

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

Function: SetBotAccessMode(player, permission, mode)

Description: Sets the recruitment-access property and audits an accepted setting when connected. Accepting an unchanged mode still returns true.

Parameters: player: player spawn. permission: exact string "recruit". Case-insensitive mode: inherit, deny, npc, or direct.

Returns: True for accepted input; false otherwise.

Connection lifetime: Each player or group-member connection resolved by this function is retained through the native call. A disconnect or reconnect during a callback cannot destroy that retained connection or switch the ongoing call to a replacement. A later Lua call resolves the current connection. This does not extend the lifetime of unrelated spawn or item userdata.

Original Player ownership: The property change and its audit belong to the original Player supplied to Lua. A callback or reconnect cannot move the audit to a replacement Player attached to the same connection.

Checked example

No checked example is published for this function yet. No active script call with the current C++ argument count was found.

Current registration: WorldServer/Lua/LuaInterface.cpp.