core.event module

A set of events that can be listened for using the Event module.

Usage

local Event = ELONA.require("core.Event")
local function my_chara_moved_handler(e)
   local chara = e.chara
   -- your code here
end
Event.register("core.character_moved", my_chara_moved_handler)

Events

core.game_initialized	Fired after the game has finished initially loading.
core.character_created	Fired after a character has been initially created (but not loaded from a savefile).
core.item_created	Fired after an item has been initially created (but not loaded from a savefile).
core.character_removed	Fired after a character is no longer valid for use inside scripts.
core.item_removed	Fired after an item is no longer valid for use inside scripts.
core.character_refreshed	Fired after a character is refreshed.
core.calc_character_damage	Fired before a character is damaged.
core.character_damaged	Fired after a character is damaged.
core.character_killed	Fired after a character was killed.
core.character_moved	Fired when a character is about to start moving.
core.player_turn_started	Fired when a player's turn has just started.
core.all_turns_finished	Fired when all characters have finished their actions this turn.
core.map_initialized	Fired after a map has been initialized.
core.before_map_unload	Fired before the current map is unloaded.
core.all_mods_loaded	Fired when all mods have finished loading.
core.script_loaded	Fired when the startup script finished loading.
core.script_loaded	Fired when a nefia is created.

Events

# core.game_initialized

Fired after the game has finished initially loading.

This will only ever be fired once per game session. The starting map will be initialized before this is called.

# core.character_created

Fired after a character has been initially created (but not loaded from a savefile).

Event Parameters:

chara : (LuaCharacter) the character that was created

# core.item_created

Fired after an item has been initially created (but not loaded from a savefile).

Event Parameters:

item : (LuaItem) the item that was created

# core.character_removed

Fired after a character is no longer valid for use inside scripts.

Event Parameters:

chara : (LuaCharacter) the character that was removed

# core.item_removed

Fired after an item is no longer valid for use inside scripts.

Event Parameters:

item : (LuaItem) the item that was removed

# core.character_refreshed

Fired after a character is refreshed.

This means various attributes like speed are recalculated. Also, intrinsic character flags (the first 32) will be automatically set from their prototype definitions on refresh. This means that if you want to set a character's intrinsic flag, you have to do so on this event.

Event Parameters:

chara : (LuaCharacter) the character that was refreshed

See also:

LuaCharacter.set_flag

# core.calc_character_damage

Fired before a character is damaged.

You can change the amount of damage taken by modifying amount.

Event Parameters:

target : (LuaCharacter) the character will be damaged
element : (Enums.Element) the element type of the damage (optional)
source : (Enums.DamageSource or LuaCharacter) the source of the damage
damage : (num) (mut) the amount of damage

# core.character_damaged

Fired after a character is damaged.

Event Parameters:

target : (LuaCharacter) the character that was damaged
element : (Enums.Element) the element type of the damage (optional)
source : (Enums.DamageSource or LuaCharacter) the source of the damage
damage : (num) the amount of damage

# core.character_killed

Fired after a character was killed.

This might not remove the character, because they might revive at some later time (like NPCs in towns). As such, you shouldn't remove the character's data from global storage here.

Event Parameters:

target : (LuaCharacter) the character that was killed
element : (Enums.Element) the element type of the damage received (optional)
source : (Enums.DamageSource or LuaCharacter) the source of the killing
damage : (num) the amount of damage that caused the killing

# core.character_moved

Fired when a character is about to start moving.

Event Parameters:

chara : (LuaCharacter) the character that is moving

Usage:

local GUI = ELONA.require("core.GUI")
local Event = ELONA.require("core.Event")

local function my_chara_moved_handler(e)
    GUI.txt("The character " .. e.chara.name .. " is about to move. ")
end

Event.register("core.character_moved", my_chara_moved_handler)

# core.player_turn_started

Fired when a player's turn has just started.

# core.all_turns_finished

Fired when all characters have finished their actions this turn.

# core.map_initialized

Fired after a map has been initialized.

Event Parameters:

regenerated : (bool) true if this map was reset to its initial
id : (string) ID of the map
index : (num) the instance index of the map state on load

Usage:

local Chara = ELONA.require("core.Chara")
local Event = ELONA.require("core.Event")
local Map = ELONA.require("core.Map")

local function place_characters()
    for i=0, 50 do
        local pos = Map.random_pos()
        Chara.create(pos, "core.putit")
    end
end

Event.register("core.map_initialized", place_characters)

# core.before_map_unload

Fired before the current map is unloaded.

# core.all_mods_loaded

Fired when all mods have finished loading.

# core.script_loaded

Fired when the startup script finished loading.

This is only fired when the startup script config option is used.

# core.script_loaded

Fired when a nefia is created.

Event Parameters:

nefia : (LuaArea) the created nefia