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

  1. If you haven't already, clone AzerothCore from our GitHub repository
  2. Go to the modules directory and run the following command:
    git clone https://github.com/azerothcore/mod-eluna.git mod-eluna
  3. Run CMake
  4. 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

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

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

Inherits all methods from: Object, WorldObject

Global

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

Group

Inherits all methods from: none

Guild

Inherits all methods from: none

Item

Inherits all methods from: Object

ItemTemplate

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

Inherits all methods from: none

Roll

Spell

An instance of a spell, created when the spell is cast by a Unit.

Unit

Inherits all methods from: Object, WorldObject

Vehicle

Inherits all methods from: none

WorldObject

Inherits all methods from: Object

WorldPacket

A packet used to pass messages between the server and a client.

Generated on
©2016 - Eluna Lua Engine