# Class Global [-] [+]

These functions can be used anywhere at any time, including at start-up.

## Methods

AddTaxiPath | Adds a taxi path to a specified map, returns the used pathId.
AddVendorItem | Adds an Item to a vendor and updates the world database.
AddVendorItemCount | Adds an Item count to a vendor.
Ban | Ban's a Player's account, character or IP
CharDBExecute | Executes a SQL query on the character database.
CharDBQuery | Executes a SQL query on the character database and returns an ElunaQuery.
CharDBQueryAsync | Initiates an asynchronous SQL query on the character database with a callback function.
ClearBattleGroundEvents | Unbinds event handlers for either all BattleGround events, or one type of event.
ClearCreatureEvents | Unbinds event handlers for either all of a Creature's events, or one type of event.
ClearCreatureGossipEvents | Unbinds event handlers for either all of a Creature's gossip events, or one type of event.
ClearGameObjectEvents | Unbinds event handlers for either all of a GameObject's events, or one type of event.
ClearGameObjectGossipEvents | Unbinds event handlers for either all of a GameObject's gossip events, or one type of event.
ClearGroupEvents | Unbinds event handlers for either all Group events, or one type of Group event.
ClearGuildEvents | Unbinds event handlers for either all Guild events, or one type of Guild event.
ClearInstanceEvents | Unbinds event handlers for either all of an instanced Map's events, or one type of event.
ClearItemEvents | Unbinds event handlers for either all of an Item's events, or one type of event.
ClearItemGossipEvents | Unbinds event handlers for either all of an Item's gossip events, or one type of event.
ClearMapEvents | Unbinds event handlers for either all of a non-instanced Map's events, or one type of event.
ClearPacketEvents | Unbinds event handlers for either all of a WorldPacket opcode's events, or one type of event.
ClearPlayerEvents | Unbinds event handlers for either all Player events, or one type of Player event.
ClearPlayerGossipEvents | Unbinds event handlers for either all of a Player's gossip events, or one type of event.
ClearServerEvents | Unbinds event handlers for either all server events, or one type of event.
ClearUniqueCreatureEvents | Unbinds event handlers for either all of a Creature's events, or one type of event.
CreateLongLong | Returns an object representing a `long long` (64-bit) value.
CreateLuaEvent | Registers a global timed event.
CreatePacket | Creates a WorldPacket.
CreateULongLong | Returns an object representing an `unsigned long long` (64-bit) value.
GetActiveGameEvents | Returns the currently active game events.
GetAreaName | Returns the area or zone's name.
GetCoreExpansion | Returns emulator's supported expansion.
GetCoreName | Returns emulator's name.
GetCoreVersion | Returns emulator version
GetCurrTime | Returns the server's current time.
GetGUIDEntry | Returns the entry ID from a GUID.
GetGUIDLow | Returns the low GUID from a GUID.
GetGUIDType | Returns the type ID from a GUID.
GetGameTime | Returns game time in seconds
GetGameTimeMS | Returns game time in milliseconds
GetGuildByLeaderGUID | Returns Guild by the leader's GUID
GetGuildByName | Returns a Guild by name.
GetItemGUID | Builds an Item's GUID.
GetItemLink | Returns an chat link for an Item.
GetLuaEngine | Returns Lua engine's name.
GetMapById | Returns a Map by ID.
GetObjectGUID | Builds a GameObject's GUID.
GetPlayerByGUID | Finds and Returns Player by guid if found
GetPlayerByName | Finds and Returns Player by name if found
GetPlayerCount | Returns the amount of Players in the world.
GetPlayerGUID | Builds a Player's GUID
GetPlayersInWorld | Returns a table with all the current Players in the world
GetPlayersOnMap | Returns a table with all the current Players on the states map.
GetQuest | Returns Quest template
GetRealmID | Returns emulator .conf RealmID
GetSpellInfo | Returns the SpellInfo of entry
GetStateInstanceId | Returns the instance ID of the Lua state. Returns 0 for continent maps and the world state.
GetStateMap | Returns the Map pointer of the Lua state. Returns null for the "World" state.
GetStateMapId | Returns the map ID of the Lua state. Returns -1 for the "World" state.
GetTimeDiff | Returns the difference between an old timestamp and the current time.
GetUnitGUID | Builds a Creature's GUID.
HasVendorItem | Checks if vendor has an Item.
IsBagPos | Returns `true` if the bag and slot is a valid bag position, otherwise `false`.
IsBankPos | Returns `true` if the bag and slot is a valid bank position, otherwise `false`.
IsEquipmentPos | Returns `true` if the bag and slot is a valid equipment position, otherwise `false`.
IsGameEventActive | Returns `true` if the event is currently active, otherwise `false`.
IsInventoryPos | Returns `true` if the bag and slot is a valid inventory position, otherwise `false`.
Kick | Kicks a Player from the server.
PerformIngameSpawn | Performs an in-game spawn and returns the Creature or GameObject spawned.
PrintDebug | Prints given parameters to the debug log.
PrintError | Prints given parameters to the error log.
PrintInfo | Prints given parameters to the info log.
RegisterAuraEffectEvent | Registers a AuraEffect event handler.
RegisterAuraEvent | Registers a Aura event handler.
RegisterBGEvent | Registers a BattleGround event handler.
RegisterCreatureEvent | Registers a Creature event handler.
RegisterCreatureGossipEvent | Registers a Creature gossip event handler.
RegisterGameObjectEvent | Registers a GameObject event handler.
RegisterGameObjectGossipEvent | Registers a GameObject gossip event handler.
RegisterGroupEvent | Registers a Group event handler.
RegisterGuildEvent | Registers a Guild event handler.
RegisterInstanceEvent | Registers a Map event handler for one instance of a Map.
RegisterItemEvent | Registers an Item event handler.
RegisterItemGossipEvent | Registers an Item gossip event handler.
RegisterMapEvent | Registers a Map event handler for all instance of a Map.
RegisterPacketEvent | Registers a WorldPacket event handler.
RegisterPetEvent | Registers a Pet event handler.
RegisterPlayerEvent | Registers a Player event handler.
RegisterPlayerGossipEvent | Registers a Player gossip event handler.
RegisterServerEvent | Registers a server event handler.
RegisterSpellEffectEvent | Registers a Spell effect event handler.
RegisterSpellEvent | Registers a Spell event handler.
RegisterUniqueCreatureEvent | Registers a Creature event handler for a single Creature.
ReloadEluna | Reloads the Lua engine.
RemoveAllVendorItems | Removes all Items from a vendor and updates the database.
RemoveEventById | Removes a global timed event specified by ID.
RemoveEvents | Removes all global timed events.
RemoveVendorItem | Removes an Item from a vendor and updates the database.
RollChance | Returns the roll result of chance
RunCommand | Runs a command.
SaveAllPlayers | Saves all Players.
SendMail | Sends mail to a Player.
SendWorldMessage | Sends a message to all Players online.
StartGameEvent | Starts the event by eventId, if force is set, the event will force start regardless of previous event state.
StopGameEvent | Stops the event by eventId, if force is set, the event will force stop regardless of previous event state.
WorldDBExecute | Executes a SQL query on the world database.
WorldDBQuery | Executes a SQL query on the world database and returns an ElunaQuery.
WorldDBQueryAsync | Initiates an asynchronous SQL query on the world database with a callback function.
bit_and | Performs a bitwise AND (a & b).
bit_lshift | Performs a bitwise left-shift (a << b).
bit_not | Performs a bitwise NOT (~a).
bit_or | Performs a bitwise OR (a | b).
bit_rshift | Performs a bitwise right-shift (a >> b).
bit_xor | Performs a bitwise XOR (a ^ b).

# Keyboard shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

# Search tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct` (or `str`), `enum`, `trait`, `typedef` (or `tdef`).

Generated on
© 2010 - 2024 Eluna Lua Engine