Eluna API Documentation [-] [+]

The Eluna Lua Engine© API

The Eluna Lua Engine© API allows you to add your own Lua code to be executed when certain events (called "hooks") occur.

Add a new in-game command, give life to creatures with new AI, or even light players who try to duel on fire! If the hook exists, you can script it.

About Eluna

Eluna is a Lua engine for World of Warcraft emulators. These pages are for AzerothCore's version, but Eluna also supports CMaNGOS/MaNGOS and TrinityCore.

If you come from the TypeScript / JavaScript world, or would prefer to use a typed language instead of Lua, check out eluna-ts!

You can get support in the #eluna-ac channel of AzerothCore's Discord server.

You can also join the official Eluna Discord server, where you'll be able to find resources, releases and support provided by the Eluna community.

How to Install

If you haven't already, clone AzerothCore from our GitHub repository

Go to the modules directory and run the following command:

git clone https://github.com/azerothcore/mod-eluna.git mod-eluna

Run CMake
Build AzerothCore

About this Documentation

The layout, CSS, and Javascript code for this documentation was borrowed from doc.rust-lang.org.

The documentation generator was originally written by Patman64 and is maintained by the Eluna team.

Classes

Achievement	Represents an entry from the game's achievement database (e.g., achievement earned for completing certain tasks).
Aura	The persistent effect of a Spell that remains on a Unit after the Spell has been cast.
BattleGround	Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc.
ChatHandler	Provides access to in-game and console chat commands, messages, and selection context for command execution.
Corpse	The remains of a Player that has died.
Creature	Non-Player controlled Units (i.e. NPCs).
ElunaQuery	The result of a database query.
GameObject	Represents a game object in the world, such as doors, chests, and other interactive objects.
GemPropertiesEntry	Represents static gem data used in item enhancement, including spell enchantments triggered by socketed gems.
Global	These functions can be used anywhere at any time, including at start-up.
Group	Represents a player group in the game, such as a party or raid.
Guild	Represents a player guild. Used to manage guild members, ranks, guild bank.
Item	Represents an instance of an item in the game world.
ItemTemplate	Represents item data defined in the database and DBCs, such as stats, quality, class restrictions, and display info.
Loot	Represents loot data for items, gold, and other rewards dropped by creatures or objects.
Map	A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc.
Object	A basic game object (either an Item or a WorldObject).
Player	Inherits all methods from: Object, WorldObject, Unit
Quest	Represents a quest in the game, including its objectives, rewards, and conditions.
Roll	Represents a group loot roll session for an item, including player votes and roll statistics.
Spell	An instance of a spell, created when the spell is cast by a Unit.
SpellEntry	Represents spell data loaded from the DBCs, including effects, costs, attributes, and requirements.
SpellInfo	Represents spell metadata used for behavior, targeting, attributes, mechanics, auras, and conditions.
Ticket	Represents a support ticket created by a Player using the in-game ticket system.
Unit	Represents a non-Player controlled Unit (i.e. NPCs).
Vehicle	Represents a vehicle in the game, which can carry passengers and provide special abilities or movement.
WorldObject	Represents a WorldObject in the game world.
WorldPacket	A packet used to pass messages between the server and a client.

All Classes