Eluna Lua Engine

https://elunaluaengine.github.io
Admin
Eluna Lua Engine is a scripting engine for World of Warcraft emulators, enabling users to add custom...
Tokens:185,565
Snippets:1,369
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example SQL Query for `creature_template`

Source: https://elunaluaengine.github.io/ElunaQuery/GetRow

An example SQL query demonstrating how to select `entry` and `name` from the `creature_template` table, used to illustrate the input for `ElunaQuery`.

```SQL
SELECT entry, name FROM creature_template
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetAccountId

Lists various keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation, such as showing help, focusing search, and moving through results.

```APIDOC
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
```

--------------------------------

### Eluna Documentation Keyboard Shortcuts Guide

Source: https://elunaluaengine.github.io/Unit/MoveClear

A list of keyboard shortcuts designed to enhance navigation and interaction within the Eluna Lua Engine documentation. These shortcuts allow users to quickly access help, focus the search field, and navigate through search results.

```APIDOC
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
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/IsInWater

Lists keyboard shortcuts for navigating and interacting with the documentation interface, including functions for displaying help, focusing the search field, and moving through search results.

```APIDOC
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
```

--------------------------------

### Eluna Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/IsMoving

Lists keyboard shortcuts for navigating and interacting with the Eluna documentation interface, including shortcuts for showing help, focusing search, and moving through search results.

```APIDOC
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
```

--------------------------------

### Eluna Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/IsStandState

Lists various keyboard shortcuts available for navigating and interacting with the Eluna documentation. These shortcuts facilitate quick access to help, search fields, and search results.

```APIDOC
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
```

--------------------------------

### Eluna Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/GetCharmerGUID

Lists keyboard shortcuts for navigating and interacting with the Eluna documentation, including shortcuts for showing help, focusing the search field, and moving through search results.

```APIDOC
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
```

--------------------------------

### Documentation Navigation: Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Item/GetSpellId

A reference guide listing various keyboard shortcuts available for navigating and interacting with the documentation interface, such as showing help, focusing search, and moving through search results.

```APIDOC
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
```

--------------------------------

### Creature:AttackStart Method Documentation

Source: https://elunaluaengine.github.io/Creature/AttackStart

Documents the `AttackStart` method of the `Creature` object in the Eluna Lua Engine, detailing its usage, parameters, and return type.

```APIDOC
Method: Creature:AttackStart
Description: Make the Creature attack target.
Synopsis: Creature:AttackStart( target )
Arguments:
  target: Unit - See method description.
Returns: Nothing.
```

--------------------------------

### Lua Example: Get Creature Database GUID

Source: https://elunaluaengine.github.io/Creature/GetDBTableGUIDLow

Demonstrates how to call the `GetDBTableGUIDLow` method on a `Creature` object in Lua to retrieve its database GUID. The returned value `dbguid` will be a number representing the low GUID.

```Lua
dbguid = Creature:GetDBTableGUIDLow()
```

--------------------------------

### Documentation Search Tricks

Source: https://elunaluaengine.github.io/Player/GetItemByGUID

Tips and tricks for refining search queries within the Eluna Lua Engine documentation, including how to use type-specific prefixes.

```Text
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).
```

--------------------------------

### Global Method: GetObjectGUID

Source: https://elunaluaengine.github.io/Global/GetObjectGUID

Builds a GameObject's GUID. A GameObject's GUID consists of entry ID, low GUID, and type ID. A Player and GameObject, for example, can have the same low GUID but not GUID.

```APIDOC
Method: GetObjectGUID
Description: Builds a GameObject's GUID.
Synopsis: guid = GetObjectGUID( lowguid, entry )
Arguments:
  lowguid: number
    Description: Low GUID of the GameObject. Valid numbers: integers from 0 to 4,294,967,295.
  entry: number
    Description: Entry ID of the GameObject. Valid numbers: integers from 0 to 4,294,967,295.
Returns:
  guid: number
    Description: Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
```

--------------------------------

### Documentation Search Tricks and Type Prefixes

Source: https://elunaluaengine.github.io/Player/GetAccountId

Explains how to use type prefixes in search queries to refine results to specific documentation categories like functions, modules, or structs, improving search efficiency.

```APIDOC
Search Tricks:
  Description: Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.
  Accepted types: fn, mod, struct (or str), enum, trait, typedef (or tdef).
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/BattleGround/GetStatus

A list of keyboard shortcuts available for navigating and interacting with the documentation interface, providing quick access to common actions like showing help or focusing the search field.

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

--------------------------------

### Lua Example: Get WorldObject Instance ID

Source: https://elunaluaengine.github.io/WorldObject/GetInstanceId

An example demonstrating how to call the GetInstanceId method on a WorldObject in Lua to retrieve its unique instance identifier.

```Lua
instanceId = WorldObject:GetInstanceId()
```

--------------------------------

### Documentation Search Tricks

Source: https://elunaluaengine.github.io/Unit/IsInWater

Explains how to use prefixes to restrict search results to specific types within the documentation, improving search accuracy and efficiency.

```APIDOC
Search Tricks:
  Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.
  Accepted types: fn, mod, struct (or str), enum, trait, typedef (or tdef).
```

--------------------------------

### Documentation Search Query Tricks

Source: https://elunaluaengine.github.io/Player/SetSkill

Explains how to use type prefixes in search queries to narrow down results to specific documentation categories like functions, modules, or structs.

```APIDOC
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).
```

--------------------------------

### Lua Example: Retrieve Corpse Owner GUID

Source: https://elunaluaengine.github.io/Corpse/GetOwnerGUID

Demonstrates the basic usage of the `Corpse:GetOwnerGUID` method in Lua to obtain the unique identifier (GUID) of the player who owned a corpse. The returned GUID can then be used to identify the player.

```Lua
ownerGUID = Corpse:GetOwnerGUID()
```

--------------------------------

### Eluna Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/IsDead

A reference guide to keyboard shortcuts available for navigating and interacting with the Eluna documentation interface.

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

--------------------------------

### Get Unit Charm GUID (Eluna Lua API)

Source: https://elunaluaengine.github.io/Unit/GetCharmGUID

Retrieves the Global Unique Identifier (GUID) of the charmed entity associated with a Unit object in the Eluna Lua Engine. This method takes no arguments and returns a numerical GUID.

```APIDOC
Method: Unit:GetCharmGUID
  Description: Returns the GUID of the Unit's charmed entity.
  Synopsis:
    charmedGUID = Unit:GetCharmGUID()
  Arguments: None
  Returns:
    charmedGUID: number (integer from 0 to 18,446,744,073,709,551,615)
```

--------------------------------

### Lua Example: Get Player Quest Reward Status

Source: https://elunaluaengine.github.io/Player/GetQuestRewardStatus

An example demonstrating how to call the `Player:GetQuestRewardStatus` method in Lua to retrieve the reward status of a quest.

```Lua
questRewardStatus = Player:GetQuestRewardStatus( questId )
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/ElunaQuery/NextRow

A reference list of keyboard shortcuts designed to enhance navigation and interaction within the Eluna Lua Engine documentation interface.

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

--------------------------------

### Get Controller GUID for Unit (Lua API)

Source: https://elunaluaengine.github.io/Unit/GetControllerGUID

Documents the `GetControllerGUID` method of the `Unit` class in the Eluna Lua Engine. This method retrieves the Global Unique Identifier (GUID) of the Unit's charmer or owner. It takes no arguments and returns a numerical GUID.

```APIDOC
Class: Unit
Method: GetControllerGUID
  Description: Returns the GUID of the Unit's charmer or owner.
  Synopsis: controllerGUID = Unit:GetControllerGUID()
  Arguments: None
  Returns:
    controllerGUID: number
      Description: Valid integers from 0 to 18,446,744,073,709,551,615.
```

--------------------------------

### Player:StartTaxi Method API Details

Source: https://elunaluaengine.github.io/Player/StartTaxi

Detailed API documentation for the `Player:StartTaxi` method, including its parameters, their types, descriptions, valid ranges, and the method's return value. This method requires a valid path ID.

```APIDOC
Player:
  StartTaxi(pathId: number)
    pathId:
      Type: number (integer)
      Description: PathId from DBC or Global:AddTaxiPath.
      Valid Range: 0 to 4,294,967,295.
    Returns: Nothing.
```

--------------------------------

### Player:SendMovieStart Method API Reference

Source: https://elunaluaengine.github.io/Player/SendMovieStart

This API documentation describes the `SendMovieStart` method available on the Player object in the Eluna Lua Engine. It details how to initiate a movie playback for a player by providing a specific MovieId.

```APIDOC
Player:SendMovieStart(MovieId)
  Description: Starts a movie for the Player.
  Arguments:
    MovieId: number
      Description: Entry of a movie.
      Valid numbers: integers from 0 to 4,294,967,295.
  Returns: Nothing.
```

--------------------------------

### Lua Example: Get Map from BattleGround

Source: https://elunaluaengine.github.io/BattleGround/GetMap

A simple Lua code example demonstrating how to call the GetMap method on a BattleGround object to retrieve its associated Map.

```Lua
map = BattleGround:GetMap()
```

--------------------------------

### Documentation Navigation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/SetSkill

Lists various keyboard shortcuts available for navigating and interacting with the documentation interface, such as showing help, focusing search, and moving through search results.

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

--------------------------------

### Lua Example: Get Player Mana Bonus from Intellect

Source: https://elunaluaengine.github.io/Player/GetManaBonusFromIntellect

A Lua code example demonstrating the usage of the `Player:GetManaBonusFromIntellect` method to retrieve the calculated mana bonus.

```Lua
bonus = Player:GetManaBonusFromIntellect()
```

--------------------------------

### Lua Example: Get Unit Power Percentage

Source: https://elunaluaengine.github.io/Unit/GetPowerPct

An example of how to call the `Unit:GetPowerPct` method in Lua to retrieve a unit's power percentage based on a specified power type.

```Lua
powerPct = Unit:GetPowerPct( type )
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Object/SetScale

A list of keyboard shortcuts designed to enhance navigation and interaction within the Eluna Lua Engine documentation, including shortcuts for showing help, focusing search, and navigating search results.

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

--------------------------------

### Lua Example: Get Alive Players Count by Team

Source: https://elunaluaengine.github.io/BattleGround/GetAlivePlayersCountByTeam

A concise Lua code snippet demonstrating the invocation of the `BattleGround:GetAlivePlayersCountByTeam` method. This example shows how to obtain the count of currently alive players for a specific team within a BattleGround instance.

```Lua
count = BattleGround:GetAlivePlayersCountByTeam( team )
```

--------------------------------

### Documentation Search Tricks

Source: https://elunaluaengine.github.io/ElunaQuery/NextRow

Guidelines and accepted type prefixes for refining search queries within the Eluna Lua Engine documentation, allowing users to narrow down results by specific content types.

```APIDOC
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).
```

--------------------------------

### Lua Example: Get WorldPacket Opcode

Source: https://elunaluaengine.github.io/WorldPacket/GetOpcode

Demonstrates how to call the `GetOpcode` method on a `WorldPacket` object in Lua to retrieve its associated opcode.

```Lua
opcode = WorldPacket:GetOpcode()
```

--------------------------------

### API Documentation for Unit:GetCreatorGUID Method

Source: https://elunaluaengine.github.io/Unit/GetCreatorGUID

Comprehensive documentation for the `Unit:GetCreatorGUID` method, detailing its purpose, call signature, arguments, and return value with type and range specifications.

```APIDOC
Unit:GetCreatorGUID
  Description: Returns the Unit's creator's GUID.
  Synopsis: creatorGUID = Unit:GetCreatorGUID()
  Arguments: None
  Returns:
    creatorGUID: number
      Type: integer
      Range: 0 to 18,446,744,073,709,551,615
```

--------------------------------

### Lua Usage Synopsis for Unit:GetMaxPower

Source: https://elunaluaengine.github.io/Unit/GetMaxPower

A brief Lua code example demonstrating the syntax for calling the `Unit:GetMaxPower` method.

```Lua
maxPowerAmount = Unit:GetMaxPower( type )
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/IsTaxi

Lists keyboard shortcuts for navigating and interacting with the Eluna Lua Engine documentation, including functions for showing help, focusing search, moving through results, and activating links.

```APIDOC
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
```

--------------------------------

### Lua Example: Get Player Lifetime Kills

Source: https://elunaluaengine.github.io/Player/GetLifetimeKills

Illustrates the basic usage of the `Player:GetLifetimeKills()` method in Lua to retrieve a player's total honorable kills.

```Lua
lifeTimeKils = Player:GetLifetimeKills()
```

--------------------------------

### Lua Example: Get Aura Caster Level Synopsis

Source: https://elunaluaengine.github.io/Aura/GetCasterLevel

Illustrates the basic syntax for calling the `Aura:GetCasterLevel()` method in Lua to retrieve the caster's level.

```Lua
caster_level = Aura:GetCasterLevel()
```

--------------------------------

### Lua: BattleGround:GetMinLevel Method Synopsis

Source: https://elunaluaengine.github.io/BattleGround/GetMinLevel

A concise code example demonstrating the syntax for calling the `BattleGround:GetMinLevel` method in Lua and assigning its returned value to a variable.

```Lua
minLevel = BattleGround:GetMinLevel()
```

--------------------------------

### Documentation Navigation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Creature/GetLootRecipient

Lists common keyboard shortcuts available for navigating and interacting with the documentation interface, including showing help, focusing search, and moving through search results.

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

--------------------------------

### Lua Example: Get Random Raid Member

Source: https://elunaluaengine.github.io/Player/GetNextRandomRaidMember

Illustrates the basic syntax for calling the `GetNextRandomRaidMember` method on a Player object in Lua, assigning the returned Player object to a variable.

```Lua
player = Player:GetNextRandomRaidMember( radius )
```

--------------------------------

### Documentation Navigation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetInGameTime

A list of keyboard shortcuts designed to enhance navigation and interaction within the Eluna Lua Engine documentation, including shortcuts for showing help, focusing search, and navigating search results.

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

--------------------------------

### Player:GetMailItem Method API and Lua Usage

Source: https://elunaluaengine.github.io/Player/GetMailItem

Comprehensive documentation for the Player:GetMailItem method, including its API specification and a Lua usage example. This method retrieves a mailed item using its unique identifier (guid).

```APIDOC
Method: Player:GetMailItem
Description: Returns a mailed Item by guid.
Synopsis: item = Player:GetMailItem( guid )
Arguments:
  guid: number - An item guid. Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
Returns:
  item: Item - See method description.
```

```Lua
item = Player:GetMailItem( guid )
```

--------------------------------

### Lua Example: Get Player Combo Points

Source: https://elunaluaengine.github.io/Player/GetComboPoints

A practical Lua code snippet demonstrating how to call the `Player:GetComboPoints` method to obtain the current combo points for a player object. The result is assigned to the `comboPoints` variable.

```Lua
comboPoints = Player:GetComboPoints()
```

--------------------------------

### Eluna Lua Unit:IsStandState() Method Usage Example

Source: https://elunaluaengine.github.io/Unit/IsStandState

Illustrates the basic syntax for calling the `IsStandState` method on a `Unit` object in Lua. The method returns a boolean value indicating if the unit is standing, which is assigned to the `isStanding` variable.

```Lua
isStanding = Unit:IsStandState()
```

--------------------------------

### Global Method: GetPlayerGUID

Source: https://elunaluaengine.github.io/Global/GetPlayerGUID

Documents the `GetPlayerGUID` global method, which constructs a Player's GUID from a low GUID. It clarifies the distinction between low GUIDs and full GUIDs for Players and Creatures, noting that they can share low GUIDs but not full GUIDs.

```APIDOC
Method: GetPlayerGUID
Description: Builds a Player's GUID. Player GUID consist of low GUID and type ID. Player and Creature for example can have the same low GUID but not GUID.
Synopsis: guid = GetPlayerGUID( lowguid )
Arguments:
  lowguid: number (integer, 0 to 4,294,967,295)
    Description: Low GUID of the Player.
Returns:
  guid: number (integer, 0 to 18,446,744,073,709,551,615)
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Item/GetClass

Lists keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation, including help, search focus, and result navigation.

```APIDOC
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
```

--------------------------------

### Eluna Lua Unit:GetCharmerGUID Method API Reference

Source: https://elunaluaengine.github.io/Unit/GetCharmerGUID

Comprehensive API documentation for the `GetCharmerGUID` method of the `Unit` object in the Eluna Lua Engine, detailing its purpose, arguments, and return value. Includes a Lua code example for its usage.

```APIDOC
Class: Unit
  Method: GetCharmerGUID()
    Description: Returns the Unit's charmer's GUID.
    Arguments: None.
    Returns:
      charmerGUID: number
        Description: Valid integers from 0 to 18,446,744,073,709,551,615.
```

```Lua
charmerGUID = Unit:GetCharmerGUID()
```

--------------------------------

### Documentation Navigation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/ModifyMoney

A list of keyboard shortcuts available for navigating and interacting with the Eluna documentation portal, including actions like showing help, focusing search, and moving through search results.

```APIDOC
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
```

--------------------------------

### GetItemGUID Global Method API Reference

Source: https://elunaluaengine.github.io/Global/GetItemGUID

Documents the `GetItemGUID` global method in the Eluna Lua Engine, which constructs an Item's GUID from a low GUID. It clarifies the distinction between low GUIDs and full GUIDs, noting that different object types (like Player and Item) can share low GUIDs but not full GUIDs.

```APIDOC
Method: Global:GetItemGUID
Description: Builds an Item's GUID. Item GUID consist of low GUID and type ID. Player and Item for example can have the same low GUID but not GUID.
Synopsis: guid = GetItemGUID( lowguid )
Arguments:
  lowguid: number
    Description: Low GUID of the Item.
    Valid numbers: integers from 0 to 4,294,967,295.
Returns:
  guid: number
    Description: The constructed Item GUID.
    Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetItemByGUID

A list of keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation.

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

--------------------------------

### Eluna WorldObject:Data() Cache Operations in Lua

Source: https://elunaluaengine.github.io/WorldObject/Data

Demonstrates how to interact with the runtime-persistent cache tied to a WorldObject using its Data() method. This cache persists across Lua state reloads but not server restarts. Examples include setting, retrieving, and removing key-value pairs, and getting all data as a table.

```Lua
-- Sets the key-value pair in the cache
WorldObject:Data():Set("key", val)

-- Returns the value from the cache using the key
local val = WorldObject:Data():Get("key")

-- Removes the key-value pair from the cache
WorldObject:Data():Set("key", nil)

-- Returns all the key-value pairs as a Lua table indexed by the keys
local table = WorldObject:Data():AsTable()
```

--------------------------------

### Global Method: GetGUIDLow

Source: https://elunaluaengine.github.io/Global/GetGUIDLow

This method returns the low GUID component from a given full GUID. It explains the composition of a GUID (low GUID, type ID, entry ID) and clarifies how low GUIDs are used to distinguish objects of the same type across different core implementations like TrinityCore and MaNGOS/cMaNGOS, highlighting their uniqueness scope.

```APIDOC
Method: GetGUIDLow
  Description: Returns the low GUID from a GUID.
    A GUID consists of a low GUID, type ID, and possibly an entry ID depending on the type ID.
    Low GUID is an ID to distinct the objects of the same type.
    Player and Creature for example can have the same low GUID but not GUID.
    On TrinityCore all low GUIDs are different for all objects of the same type.
    For example creatures in instances are assigned new GUIDs when the Map is created.
    On MaNGOS and cMaNGOS low GUIDs are unique only on the same map.
    For example creatures in instances use the same low GUID assigned for that spawn in the database.
    This is why to identify a creature you have to know the instanceId and low GUID. See Map:GetIntstanceId
  Synopsis: lowguid = GetGUIDLow( guid )
  Arguments:
    guid: number
      Description: GUID of an Object.
      Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
  Returns:
    lowguid: number
      Description: Low GUID of the Object.
      Valid numbers: integers from 0 to 4,294,967,295.
```

--------------------------------

### Eluna Lua Engine: GetUnitGUID Global Method API

Source: https://elunaluaengine.github.io/Global/GetUnitGUID

Documents the `GetUnitGUID` global method in the Eluna Lua Engine, which constructs a Creature's GUID from a low GUID and an entry ID. It specifies the valid ranges for input parameters and the return value, clarifying that Creature and Player GUIDs are distinct even with the same low GUID.

```APIDOC
Method: Global:GetUnitGUID
Description: Builds a Creature's GUID. Creature GUID consist of entry ID, low GUID and type ID. Player and Creature for example can have the same low GUID but not GUID.

Synopsis:
  guid = GetUnitGUID( lowguid, entry )

Arguments:
  lowguid: number
    Description: Low GUID of the Creature.
    Valid numbers: integers from 0 to 4,294,967,295.
  entry: number
    Description: Entry ID of the Creature.
    Valid numbers: integers from 0 to 4,294,967,295.

Returns:
  guid: number
    Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
```

--------------------------------

### Documentation Keyboard Shortcuts Reference

Source: https://elunaluaengine.github.io/Unit/IsCasting

A reference list of keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation interface, including commands for help, search, and result navigation.

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

--------------------------------

### Global Method: GetGUIDType API Reference

Source: https://elunaluaengine.github.io/Global/GetGUIDType

Provides the API specification for the `GetGUIDType` global method, which extracts the type ID from a given GUID. The type ID differentiates between various object types such as Player, Creature, and GameObject. A GUID is composed of an entry ID, low GUID, and the type ID.

```APIDOC
Method: Global.GetGUIDType
  Description: Returns the type ID from a GUID.
  Synopsis: typeId = GetGUIDType( guid )
  Arguments:
    guid:
      Type: number (http://www.lua.org/pil/2.3.html)
      Description: GUID of an Object.
      Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
  Returns:
    typeId:
      Type: number (http://www.lua.org/pil/2.3.html)
      Description: Type ID of the Object.
      Valid numbers: integers from -2,147,483,647 to 2,147,483,647.
```

--------------------------------

### API Reference for Documentation Search Tricks

Source: https://elunaluaengine.github.io/Unit/GetHealthPct

Explains how to use type-prefixed searches to refine results within the documentation, listing all accepted type prefixes.

```APIDOC
Search tricks:
  Description: Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.
  Accepted types: fn, mod, struct (or str), enum, trait, typedef (or tdef).
```

--------------------------------

### Lua Example: Check Player Taxi Cheat Status

Source: https://elunaluaengine.github.io/Player/IsTaxiCheater

Example of how to call the IsTaxiCheater method on a Player object in Lua to determine if taxi cheat is active.

```Lua
isTaxiCheater = Player:IsTaxiCheater()
```

--------------------------------

### Search Tricks for Documentation

Source: https://elunaluaengine.github.io/Unit/SetRooted

Guidelines for using advanced search functionalities, specifically how to prefix queries to filter results by specific documentation types such as functions, modules, or structs.

```APIDOC
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).
```

--------------------------------

### Eluna Documentation Search Tricks

Source: https://elunaluaengine.github.io/Player/GetXP

Instructions on how to use type-prefixed searches to refine results within the Eluna documentation, along with a list of accepted type prefixes.

```APIDOC
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`).
```

--------------------------------

### Player:IsHorde Method Lua Usage Example

Source: https://elunaluaengine.github.io/Player/IsHorde

A Lua code example demonstrating how to call the Player:IsHorde method and capture its boolean return value.

```Lua
isHorde = Player:IsHorde()
```

--------------------------------

### Eluna Lua Engine GameObject:GetLootRecipient Usage Example

Source: https://elunaluaengine.github.io/GameObject/GetLootRecipient

An example demonstrating how to call the GetLootRecipient method on a GameObject instance in Lua to retrieve the player eligible to loot the object.

```Lua
player = GameObject:GetLootRecipient()
```

--------------------------------

### Keyboard Shortcuts for Documentation Navigation

Source: https://elunaluaengine.github.io/Unit/SetRooted

A list of keyboard shortcuts designed to enhance navigation and interaction within the documentation interface, including actions for showing help, focusing search, and navigating search results.

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

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Item/GetSpeed

Lists keyboard shortcuts available for navigating and interacting with the documentation interface, including commands for showing help, focusing the search field, and moving through search results.

```APIDOC
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
```

--------------------------------

### Eluna Lua Player:GetChampioningFaction Usage Example

Source: https://elunaluaengine.github.io/Player/GetChampioningFaction

Example demonstrating how to call the `GetChampioningFaction` method on a `Player` object in Eluna Lua to retrieve the championing faction ID.

```Lua
championingFaction = Player:GetChampioningFaction()
```

--------------------------------

### Lua Example: Calling Item:GetFlags()

Source: https://elunaluaengine.github.io/Item/GetFlags

A practical Lua code example demonstrating how to invoke the `Item:GetFlags()` method on an Item object to obtain its associated flags.

```Lua
flags = Item:GetFlags()
```

--------------------------------

### Documentation Search Query Tricks

Source: https://elunaluaengine.github.io/Player/GetShieldBlockValue

Instructions on how to effectively use search prefixes to narrow down results within the documentation. This section specifies the accepted type prefixes for more precise searches.

```APIDOC
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`).
```

--------------------------------

### Lua Example: Retrieve Item Purchase Count

Source: https://elunaluaengine.github.io/Item/GetBuyCount

A simple Lua code example demonstrating how to call the Item:GetBuyCount() method on an Item object to obtain its default purchase count.

```Lua
count = Item:GetBuyCount()
```

--------------------------------

### Documentation Search Tricks and Type Prefixes

Source: https://elunaluaengine.github.io/BattleGround/GetStatus

Instructions on how to use type prefixes to refine search queries within the documentation, listing accepted types such as functions, modules, structs, enums, traits, and typedefs.

```Text
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`).
```

--------------------------------

### Lua Group:IsBGGroup Method Call Example

Source: https://elunaluaengine.github.io/Group/IsBGGroup

A concise Lua code example demonstrating the basic syntax for invoking the `IsBGGroup` method on a `Group` object.

```Lua
isBG = Group:IsBGGroup()
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Global/bit_and

Lists keyboard shortcuts available for interacting with the documentation interface, including commands to show help, focus the search field, navigate search results, and activate a selected search result.

```APIDOC
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
```

--------------------------------

### API Reference for Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Unit/GetHealthPct

Lists keyboard shortcuts available for navigating and interacting with the Eluna documentation interface.

```APIDOC
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
```

--------------------------------

### ElunaQuery:NextRow Lua Usage Example

Source: https://elunaluaengine.github.io/ElunaQuery/NextRow

A concise example demonstrating the syntax for calling the ElunaQuery:NextRow method in Lua to check for the presence of the next row in a query result.

```Lua
hadNextRow = ElunaQuery:NextRow()
```

--------------------------------

### Eluna Lua Example: Check Compatibility Mode

Source: https://elunaluaengine.github.io/Global/IsCompatibilityMode

Example of how to call the IsCompatibilityMode global method in Eluna Lua to determine the engine's current operational mode (compatibility or multistate).

```Lua
isCompatibilityMode = IsCompatibilityMode()
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Item/GetBagSize

Provides a list of keyboard shortcuts for navigating the Eluna Lua Engine documentation, including showing help, focusing the search field, and moving through search results.

```APIDOC
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
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/SendTaxiMenu

A list of keyboard shortcuts designed to enhance navigation and interaction within the documentation interface, including actions like displaying help, focusing the search bar, and moving through search results.

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

--------------------------------

### Eluna Lua Engine Object:GetTypeId Method Usage Example

Source: https://elunaluaengine.github.io/Object/GetTypeId

An example demonstrating the basic usage of the `Object:GetTypeId()` method in Lua, showing how to retrieve the type ID of an object.

```Lua
typeID = Object:GetTypeId()
```

--------------------------------

### BattleGround Class API Reference

Source: https://elunaluaengine.github.io/BattleGround/index

Documentation for the BattleGround class, detailing its purpose and available methods for interacting with battleground instances.

```APIDOC
Class BattleGround:
  Description: Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc.
  Inherits: none

  Methods:
    GetAlivePlayersCountByTeam(teamId: number) -> number
      Description: Returns the amount of alive players in the BattleGround by the team ID.
    GetBonusHonorFromKillCount() -> number
      Description: Returns the bonus honor given by amount of kills in the specific BattleGround.
    GetBracketId() -> number
      Description: Returns the bracket ID of the specific BattleGround.
    GetEndTime() -> number
      Description: Returns the end time of the BattleGround.
    GetFreeSlotsForTeam(teamId: number) -> number
      Description: Returns the amount of free slots for the selected team in the specific BattleGround.
    GetInstanceId() -> number
      Description: Returns the instance ID of the BattleGround.
    GetMap() -> Map
      Description: Returns the Map of the BattleGround.
    GetMapId() -> number
      Description: Returns the map ID of the BattleGround.
    GetMaxLevel() -> number
      Description: Returns the max allowed Player level of the specific BattleGround.
    GetMaxPlayers() -> number
      Description: Returns the maximum allowed Player count of the specific BattleGround.
    GetMaxPlayersPerTeam() -> number
      Description: Returns the maximum allowed Player count per team of the specific BattleGround.
    GetMinLevel() -> number
      Description: Returns the minimum allowed Player level of the specific BattleGround.
    GetMinPlayers() -> number
      Description: Returns the minimum allowed Player count of the specific BattleGround.
    GetMinPlayersPerTeam() -> number
      Description: Returns the minimum allowed Player count per team of the specific BattleGround.
    GetName() -> string
      Description: Returns the name of the BattleGround.
    GetStatus() -> number
      Description: Returns the status of the specific BattleGround.
    GetTypeId() -> number
      Description: Returns the type ID of the BattleGround.
    GetWinner() -> number
      Description: Returns the winning team of the specific BattleGround.
```

--------------------------------

### Example Lua Table Result from `ElunaQuery:GetRow`

Source: https://elunaluaengine.github.io/ElunaQuery/GetRow

An example of the Lua table structure returned by `ElunaQuery:GetRow`, showing how SQL query results are mapped to a Lua table with field names as keys and values.

```Lua
{ entry = 123, name = "some creature name" }
```

--------------------------------

### Lua Example: Player GetBattlegroundId Method Call

Source: https://elunaluaengine.github.io/Player/GetBattlegroundId

A concise Lua code example demonstrating the typical syntax for calling the `GetBattlegroundId` method on a Player object to obtain its current battleground ID, assigning the result to a variable.

```Lua
battleGroundId = Player:GetBattlegroundId()
```

--------------------------------

### Lua Example: Retrieve Creature Extra Flags

Source: https://elunaluaengine.github.io/Creature/GetExtraFlags

An example demonstrating how to call the `GetExtraFlags` method on a `Creature` object in Lua to retrieve its extra flags, which can then be used to determine or modify NPC behavior.

```Lua
extraFlags = Creature:GetExtraFlags()
```

--------------------------------

### Documentation Navigation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetEquippedItemBySlot

Provides a list of keyboard shortcuts for efficient navigation and interaction within the Eluna Lua Engine documentation interface, including showing help, focusing search, and navigating search results.

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

--------------------------------

### Player:EquipItem Method Usage and API Reference

Source: https://elunaluaengine.github.io/Player/EquipItem

Provides both a Lua code example for using the Player:EquipItem method and its comprehensive API documentation, detailing parameters, return values, and valid slot identifiers for equipping items in the Eluna Lua Engine.

```Lua
equippedItem = Player:EquipItem( item, slot )
equippedItem = Player:EquipItem( entry, slot )
```

```APIDOC
Player:EquipItem(item, slot)
Player:EquipItem(entry, slot)

Description: Equips the given item or item entry to the given slot. Returns the equipped item or nil.

Arguments:
  item: Item to equip. Type: [Item]
  entry: Entry of the item to equip. Type: [number] (Valid numbers: integers from 0 to 4,294,967,295)
  slot: Equipment slot to equip the item to. Type: [number] (Valid numbers: integers from 0 to 4,294,967,295). The slot can be [EquipmentSlots] or [InventorySlots].

Returns:
  equippedItem: Item or nil if equipping failed. Type: [Item]

Equipment Slots:
  EQUIPMENT_SLOT_HEAD: 0
  EQUIPMENT_SLOT_NECK: 1
  EQUIPMENT_SLOT_SHOULDERS: 2
  EQUIPMENT_SLOT_BODY: 3
  EQUIPMENT_SLOT_CHEST: 4
  EQUIPMENT_SLOT_WAIST: 5
  EQUIPMENT_SLOT_LEGS: 6
  EQUIPMENT_SLOT_FEET: 7
  EQUIPMENT_SLOT_WRISTS: 8
  EQUIPMENT_SLOT_HANDS: 9
  EQUIPMENT_SLOT_FINGER1: 10
  EQUIPMENT_SLOT_FINGER2: 11
  EQUIPMENT_SLOT_TRINKET1: 12
  EQUIPMENT_SLOT_TRINKET2: 13
  EQUIPMENT_SLOT_BACK: 14
  EQUIPMENT_SLOT_MAINHAND: 15
  EQUIPMENT_SLOT_OFFHAND: 16
  EQUIPMENT_SLOT_RANGED: 17
  EQUIPMENT_SLOT_TABARD: 18

Bag Slots:
  INVENTORY_SLOT_BAG_START: 19
  INVENTORY_SLOT_BAG_END: 23
```

--------------------------------

### API Method: Unit:GetOwnerGUID

Source: https://elunaluaengine.github.io/Unit/GetOwnerGUID

Documents the `GetOwnerGUID` method of the `Unit` object in the Eluna Lua Engine. This method retrieves the Global Unique Identifier (GUID) of a Unit's owner. It accepts no arguments and returns a numerical GUID.

```APIDOC
Method: Unit:GetOwnerGUID
Description: Returns the Unit's owner's GUID.

Synopsis:
  ownerGUID = Unit:GetOwnerGUID()

Arguments:
  None.

Returns:
  ownerGUID: number
    Description: Valid numbers are integers from 0 to 18,446,744,073,709,551,615.
```

--------------------------------

### Eluna Documentation Search Tricks

Source: https://elunaluaengine.github.io/Player/GetDbcLocale

Guidelines for using advanced search functionalities within the Eluna documentation. This includes how to use type prefixes to narrow down search results to specific documentation categories.

```APIDOC
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).
```

--------------------------------

### Eluna Lua Item:GetOwnerGUID Method

Source: https://elunaluaengine.github.io/Item/GetOwnerGUID

Documents the `GetOwnerGUID` method of the `Item` object in Eluna Lua. This method retrieves the unique identifier (GUID) of the Player who currently possesses the item. It takes no arguments and returns a numerical GUID.

```APIDOC
Item:GetOwnerGUID()
  Description: Returns GUID of the Player who currently owns the Item
  Synopsis: guid = Item:GetOwnerGUID()
  Arguments: None
  Returns:
    guid: number
      Description: Guid of the Player who owns the Item.
      Constraints: integers from 0 to 18,446,744,073,709,551,615
```

--------------------------------

### Documentation Search Tricks

Source: https://elunaluaengine.github.io/Global/SendWorldMessage

Guidelines and tips for effectively using the search functionality within the Eluna Lua Engine documentation, including type-prefixed searches.

```APIDOC
Search Tricks:
  Description: Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.
  Accepted types: fn, mod, struct (or str), enum, trait, typedef (or tdef).
```

--------------------------------

### Lua Usage Example: Creature:GetDefaultMovementType

Source: https://elunaluaengine.github.io/Creature/GetDefaultMovementType

This snippet provides a practical example of how to call the `GetDefaultMovementType` method on a `Creature` object in Lua. It demonstrates the syntax for obtaining the creature's default movement type and assigning it to a variable.

```Lua
defaultMovementType = Creature:GetDefaultMovementType()
```

--------------------------------

### BattleGround:GetStatus Method API Documentation

Source: https://elunaluaengine.github.io/BattleGround/GetStatus

Detailed API documentation for the `BattleGround:GetStatus` method, including its purpose, synopsis, arguments, and return value within the Eluna Lua Engine context.

```APIDOC
Method: BattleGround:GetStatus
Description: Returns the status of the specific BattleGround.
Synopsis:
  status = BattleGround:GetStatus()
Arguments: None.
Returns:
  status: BattleGroundStatus - See method description.
```

--------------------------------

### Eluna Lua: GetRealmID Method Usage Example

Source: https://elunaluaengine.github.io/Global/GetRealmID

A simple Lua code example demonstrating how to call the GetRealmID global method in the Eluna Lua Engine to retrieve the current realm identifier. The returned value is assigned to the 'realm' variable.

```Lua
realm = GetRealmID()
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetTeam

Lists keyboard shortcuts for navigating and interacting with the documentation, such as showing help, focusing the search field, and moving through search results.

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

--------------------------------

### Lua Example: Set GameObject Loot State

Source: https://elunaluaengine.github.io/GameObject/SetLootState

A simple Lua example demonstrating the signature for calling the GameObject:SetLootState method. This snippet shows the correct syntax for invoking the function with its required 'state' parameter.

```Lua
GameObject:SetLootState( state )
```

--------------------------------

### Lua Example: Check Creature Reputation Gain Status

Source: https://elunaluaengine.github.io/Creature/IsReputationGainDisabled

A concise Lua code example demonstrating how to call the `IsReputationGainDisabled` method on a `Creature` object. This snippet shows the basic syntax for retrieving the reputation gain status.

```Lua
reputationDisabled = Creature:IsReputationGainDisabled()
```

--------------------------------

### Documentation Keyboard Shortcuts Reference

Source: https://elunaluaengine.github.io/Unit/GetVehicle

A list of keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation interface, including shortcuts for help, search, and result navigation.

```APIDOC
?
:   Show this help dialog

S
:   Focus the search field

⇤
:   Move up in search results

⇥
:   Move down in search results

⏎
:   Go to active search result
```

--------------------------------

### Lua: Check if Creature Can Fly Example

Source: https://elunaluaengine.github.io/Creature/CanFly

A simple Lua code snippet demonstrating the direct usage of the `Creature:CanFly()` method. This example shows how to call the method and assign its boolean return value to a variable.

```Lua
canFly = Creature:CanFly()
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Creature/GetCorpseDelay

A list of keyboard shortcuts available for navigating and interacting with the Eluna Lua Engine documentation. These shortcuts provide quick access to common actions like showing help or focusing the search field.

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

--------------------------------

### Player:SendShowMailBox Method Documentation

Source: https://elunaluaengine.github.io/Player/SendShowMailBox

Documents the `SendShowMailBox` method for the `Player` object in the Eluna Lua Engine. This method displays the mailbox window to a player, identified by a specific GUID. It requires a numerical GUID as input and returns nothing.

```APIDOC
Player:SendShowMailBox(guid)
  Description: Shows the mailbox window to the player from specified guid.
  Arguments:
    guid: number (playerguid)
      Description: Guid of the mailbox window sender.
      Valid numbers: integers from 0 to 18,446,744,073,709,551,615.
  Returns: Nothing.
```

--------------------------------

### Documentation Keyboard Shortcuts

Source: https://elunaluaengine.github.io/Player/GetGroupInvite

A list of keyboard shortcuts designed to enhance navigation and interaction within the Eluna Lua Engine documentation. These shortcuts allow users to quickly access help, focus the search field, and move through search results.

```APIDOC
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
```
Tokens:
Raw