ff_i_events_c

Event constants.

ON_REGISTER

Manually sent event (during ff_x_modstart) to signal units to register.

ON_MODULE_CREATED

Manually sent event (during ff_x_modstart) sent before ff_x_modstart finishes.

ON_MODULE_LOAD

Default module script.

ON_MODULE_START

Sent after ON_MODULE_CREATED during ff_x_modstart, but before the default ON_MODULE_LOAD script.

ON_MODULE_SHUTDOWN

Last message ever sent.

ON_MODULE_VERIFY

Manually sent event (during ff_x_modstart) if in debug (before ON_MODULE_CREATED)

ON_AREA_CREATED

Manually sent event (during ff_x_modstart)

ON_AREA_VERIFY

Manually sent event (during ff_x_modstart) if in debug (before ON_AREA_CREATED)

ON_DEFAULT_ATTACK

TODO.

ON_DEFAULT_DAMAGE

TODO.

ON_OBJECT_CREATED

Manually sent event (during ff_x_modstart)

ON_OBJECT_VERIFY

Manually sent event (during ff_x_modstart) if in debug (before ON_AREA_CREATED)

ON_ITEM_CREATED

Manually sent event via CreateItemOnObjectEx.

ON_BEFORE_PLAYER_ELC

Sent by login event.

ON_AFTER_PLAYER_ELC

Sent by login event.

ON_DEFAULT_PLAYER_ELC_FAILURE

Sent by login event.

ON_TRANSITION

Sent when clicking on a transition.

CONSOLE_ARGS

Arguments to be passed to console command.

CONSOLE_COMMAND

Command to be passed to console command.

ON_CONSOLE_COMMAND

ON_CONSOLE_COMMAND_HELP

ON_USER_DEFINED

Not sent, but used to store global UD scripts.

ON_NUI_EVENT

TODO.

ON_DEFAULT_AREA_ENTER

ON_DEFAULT_AREA_ENTER_ONCE

ON_DEFAULT_AREA_EXIT

ON_BEFORE_ATTACK_TARGET_CHANGE

ON_AFTER_ATTACK_TARGET_CHANGE

ON_CALENDAR_DAWN

ON_CALENDAR_DUSK

ON_CALENDAR_DAY

ON_CALENDAR_HOUR

ON_CALENDAR_MONTH

ON_CALENDAR_YEAR

ON_CALENDAR_TIME_CHANGED

Only sent manually and on start.

ON_DEFAULT_CLIENT_ENTER

ON_DEFAULT_CLIENT_ENTER_ONCE

ON_DEFAULT_CLIENT_EXIT

ON_BEFORE_CLIENT_DISCONNECT

ON_AFTER_COMBAT_EXIT

ON_DEFAULT_CREATURE_DEATH

ON_DEFAULT_ITEM_ACQUIRE

ON_BEFORE_ITEM_ACQUIRE

ON_DEFAULT_ITEM_ACTIVATE

ON_DEFAULT_ITEM_LOST

ON_AFTER_ITEM_LOST

ON_DEFAULT_ITEM_EQUIP

ON_DEFAULT_ITEM_UNEQUIP

ON_BEFORE_ITEM_EQUIP

ON_BEFORE_ITEM_EQUIP_VALIDATE

ON_BEFORE_INVENTORY_OPEN

ON_AFTER_INVENTORY_OPEN

ON_BEFORE_INVENTORY_CLOSE

ON_AFTER_INVENTORY_CLOSE

ON_BEFORE_ADD_ITEM_INVENTORY

ON_AFTER_ADD_ITEM_INVENTORY

ON_BEFORE_REMOVE_ITEM_INVENTORY

ON_AFTER_REMOVE_ITEM_INVENTORY

ON_DEFAULT_OBJECT_CLOSED

ON_DEFAULT_OBJECT_CLICKED

ON_DEFAULT_OBJECT_DAMAGE

ON_DEFAULT_OBJECT_DEATH

ON_DEFAULT_OBJECT_DIALOGUE

ON_DEFAULT_OBJECT_DISARM

ON_DEFAULT_OBJECT_LOCK

ON_DEFAULT_OBJECT_FAIL_TO_OPEN

ON_DEFAULT_OBJECT_MELEE_ATTACKED

ON_DEFAULT_OBJECT_OPENED

ON_DEFAULT_OBJECT_SPELLCASTAT

ON_DEFAULT_OBJECT_TRAPTRIGGERED

ON_DEFAULT_OBJECT_UNLOCK

ON_DEFAULT_OBJECT_USED

ON_AFTER_PC_ELC

ON_BEFORE_PC_ELC

ON_BEFORE_PLAYER_REST

ON_DEFAULT_PC_LEVELUP

ON_AFTER_PC_LEVELUP

ON_DEFAULT_PC_DEATH

ON_DEFAULT_PC_DYING

ON_DEFAULT_PC_REST

ON_DEFAULT_PC_RESPAWN

ON_DEFAULT_PC_REST_START

ON_DEFAULT_PC_REST_CANCELLED

ON_DEFAULT_PC_REST_STOP

ON_DEFAULT_PC_SKIN_EQUIPPED

ON_AFTER_PLACEABLE_CLOSE

ON_BEFORE_PLACEABLE_OPEN

ON_DEFAULT_PLAYER_CHAT

ON_DEFAULT_PLAYER_CHAT_HELP

ON_DEFAULT_PLAYER_GUIEVENT

ON_REALTIME_DAY

Sent every 24 realtime hours.

ON_REALTIME_HOUR

Sent every realtime hour.

ON_REALTIME_MINUTE

Sent every realtime minute.

ON_RESOURCE_ADDED

ON_RESOURCE_MODIFIED

ON_RESOURCE_REMOVED

ON_DEFAULT_STORE_CLOSED

ON_DEFAULT_STORE_OPENED

ON_AFTER_STORE_SELL

ON_AFTER_STORE_BUY

ON_DEFAULT_TRIGGER_ENTER

ON_DEFAULT_TRIGGER_EXIT

Source code// @code

#include "ff_i_console"

#include "nwnx_object"
#include "nwnx_events"

// =============================================================================
// CORE EVENTS
// =============================================================================

//! @var ON_REGISTER
//! @brief Manually sent event (during ff_x_modstart) to signal units to register
const string ON_REGISTER = "ON_REGISTER";

//! @var ON_MODULE_CREATED
//! @brief Manually sent event (during ff_x_modstart) sent before ff_x_modstart finishes
const string ON_MODULE_CREATED = "ON_MODULE_CREATED";

//! @var ON_MODULE_LOAD
//! @brief Default module script
const string ON_MODULE_LOAD = "ON_MODULE_LOAD";

//! @var ON_MODULE_START
//! @brief Sent after ON_MODULE_CREATED during ff_x_modstart, but before the default ON_MODULE_LOAD script
const string ON_MODULE_START = "ON_MODULE_START";

//! @var ON_MODULE_SHUTDOWN
//! @brief Last message ever sent
const string ON_MODULE_SHUTDOWN = "ON_MODULE_SHUTDOWN";

//! @var ON_MODULE_VERIFY
//! @brief Manually sent event (during ff_x_modstart) if in debug (before ON_MODULE_CREATED)
const string ON_MODULE_VERIFY = "ON_MODULE_VERIFY";

//! @var ON_AREA_CREATED
//! @brief Manually sent event (during ff_x_modstart)
const string ON_AREA_CREATED = "ON_AREA_CREATED";

//! @var ON_AREA_VERIFY
//! @brief Manually sent event (during ff_x_modstart) if in debug (before ON_AREA_CREATED)
const string ON_AREA_VERIFY = "ON_AREA_VERIFY";

//! @var ON_DEFAULT_ATTACK
//! @brief TODO
const string ON_DEFAULT_ATTACK = "ON_DEFAULT_ATTACK";

 //! @var ON_DEFAULT_DAMAGE
//! @brief TODO
const string ON_DEFAULT_DAMAGE = "ON_DEFAULT_DAMAGE";

//! @var ON_OBJECT_CREATED
//! @brief Manually sent event (during ff_x_modstart)
const string ON_OBJECT_CREATED = "ON_OBJECT_CREATED";

//! @var ON_OBJECT_VERIFY
//! @brief Manually sent event (during ff_x_modstart) if in debug (before ON_AREA_CREATED)
const string ON_OBJECT_VERIFY = "ON_OBJECT_VERIFY";

//! @var ON_ITEM_CREATED
//! @brief Manually sent event via CreateItemOnObjectEx
const string ON_ITEM_CREATED = "ON_ITEM_CREATED";

//! @var ON_BEFORE_PLAYER_ELC
//! @brief Sent by login event.
const string ON_BEFORE_PLAYER_ELC = NWNX_ON_ELC_VALIDATE_CHARACTER_BEFORE;

//! @var ON_AFTER_PLAYER_ELC
//! @brief Sent by login event.
const string ON_AFTER_PLAYER_ELC = NWNX_ON_ELC_VALIDATE_CHARACTER_AFTER;

//! @var ON_DEFAULT_PLAYER_ELC_FAILURE
//! @brief Sent by login event.
const string ON_DEFAULT_PLAYER_ELC_FAILURE = "ON_DEFAULT_PLAYER_ELC_FAILURE";

//! @var ON_TRANSITION
//! @brief Sent when clicking on a transition.
const string ON_TRANSITION = "ON_TRANSITION";

// =============================================================================
// CONSOLE EVENT
// =============================================================================

//! @var CONSOLE_ARGS
//! @brief Arguments to be passed to console command
const string CONSOLE_ARGS = "CONSOLE_ARGS";

//! @var CONSOLE_COMMAND
//! @brief Command to be passed to console command
const string CONSOLE_COMMAND = "CONSOLE_COMMAND";

const string ON_CONSOLE_COMMAND      = "ON_CONSOLE_COMMAND";
const string ON_CONSOLE_COMMAND_HELP = "ON_CONSOLE_COMMAND_HELP";


// =============================================================================
// MISC EVENTS
// =============================================================================
//! @var ON_USER_DEFINED
//! @brief Not sent, but used to store global UD scripts
const string ON_USER_DEFINED       = "ON_USER_DEFINED";

//! @var ON_NUI_EVENT
//! @brief TODO
const string ON_NUI_EVENT          = "ON_NUI_EVENT";

// =============================================================================
// GENERIC EVENTS
// =============================================================================
const string ON_DEFAULT_AREA_ENTER      = "ON_DEFAULT_AREA_ENTER";
const string ON_DEFAULT_AREA_ENTER_ONCE = "ON_DEFAULT_AREA_ENTER_ONCE";
const string ON_DEFAULT_AREA_EXIT       = "ON_DEFAULT_AREA_EXIT";

const string ON_BEFORE_ATTACK_TARGET_CHANGE = "NWNX_ON_ATTACK_TARGET_CHANGE_BEFORE";
const string ON_AFTER_ATTACK_TARGET_CHANGE = "NWNX_ON_ATTACK_TARGET_CHANGE_AFTER";

const string ON_CALENDAR_DAWN  = NWNX_ON_CALENDAR_DAWN;
const string ON_CALENDAR_DUSK  = NWNX_ON_CALENDAR_DUSK;
const string ON_CALENDAR_DAY   = NWNX_ON_CALENDAR_DAY;
const string ON_CALENDAR_HOUR  = NWNX_ON_CALENDAR_HOUR;
const string ON_CALENDAR_MONTH = NWNX_ON_CALENDAR_MONTH;
const string ON_CALENDAR_YEAR  = NWNX_ON_CALENDAR_YEAR;

//! @var ON_CALENDAR_TIME_CHANGED
//! @brief Only sent manually and on start
const string ON_CALENDAR_TIME_CHANGED = "ON_CALENDAR_TIME_CHANGED";

const string ON_DEFAULT_CLIENT_ENTER      = "ON_DEFAULT_CLIENT_ENTER";
const string ON_DEFAULT_CLIENT_ENTER_ONCE = "ON_DEFAULT_CLIENT_ENTER_ONCE";
const string ON_DEFAULT_CLIENT_EXIT       = "ON_DEFAULT_CLIENT_EXIT";
const string ON_BEFORE_CLIENT_DISCONNECT  = NWNX_ON_CLIENT_DISCONNECT_BEFORE;

const string ON_AFTER_COMBAT_EXIT         = NWNX_ON_COMBAT_EXIT_AFTER;

const string ON_DEFAULT_CREATURE_DEATH    = "ON_DEFAULT_CREATURE_DEATH"; // 5010


const string ON_DEFAULT_ITEM_ACQUIRE       = "ON_DEFAULT_ITEM_ACQUIRE";
const string ON_BEFORE_ITEM_ACQUIRE        = "NWNX_ON_ITEM_ACQUIRE_BEFORE";
const string ON_DEFAULT_ITEM_ACTIVATE      = "ON_DEFAULT_ITEM_ACTIVATE";
const string ON_DEFAULT_ITEM_LOST          = "ON_DEFAULT_ITEM_LOST";
const string ON_AFTER_ITEM_LOST            = NWNX_ON_ITEM_ACQUIRE_AFTER;
const string ON_DEFAULT_ITEM_EQUIP         = "ON_DEFAULT_ITEM_EQUIP";
const string ON_DEFAULT_ITEM_UNEQUIP       = "ON_DEFAULT_ITEM_UNEQUIPPED";
const string ON_BEFORE_ITEM_EQUIP          = "ON_BEFORE_ITEM_EQUIP";
const string ON_BEFORE_ITEM_EQUIP_VALIDATE = NWNX_ON_VALIDATE_ITEM_EQUIP_BEFORE;

const string ON_BEFORE_INVENTORY_OPEN        = NWNX_ON_ITEM_INVENTORY_OPEN_BEFORE;
const string ON_AFTER_INVENTORY_OPEN         = NWNX_ON_ITEM_INVENTORY_OPEN_AFTER;
const string ON_BEFORE_INVENTORY_CLOSE       = NWNX_ON_ITEM_INVENTORY_CLOSE_BEFORE;
const string ON_AFTER_INVENTORY_CLOSE        = NWNX_ON_ITEM_INVENTORY_CLOSE_AFTER;

const string ON_BEFORE_ADD_ITEM_INVENTORY    = NWNX_ON_INVENTORY_ADD_ITEM_BEFORE;
const string ON_AFTER_ADD_ITEM_INVENTORY     = NWNX_ON_INVENTORY_ADD_ITEM_AFTER;
const string ON_BEFORE_REMOVE_ITEM_INVENTORY = NWNX_ON_INVENTORY_REMOVE_ITEM_BEFORE;
const string ON_AFTER_REMOVE_ITEM_INVENTORY  = NWNX_ON_INVENTORY_REMOVE_ITEM_AFTER;


const string ON_DEFAULT_OBJECT_CLOSED         = "ON_DEFAULT_OBJECT_CLOSED";
const string ON_DEFAULT_OBJECT_CLICKED        = "ON_DEFAULT_OBJECT_CLICKED";
const string ON_DEFAULT_OBJECT_DAMAGE         = "ON_DEFAULT_OBJECT_DAMAGE";
const string ON_DEFAULT_OBJECT_DEATH          = "ON_DEFAULT_OBJECT_DEATH";
const string ON_DEFAULT_OBJECT_DIALOGUE       = "ON_DEFAULT_OBJECT_DIALOGUE";
const string ON_DEFAULT_OBJECT_DISARM         = "ON_DEFAULT_OBJECT_DISARM";
const string ON_DEFAULT_OBJECT_LOCK           = "ON_DEFAULT_OBJECT_LOCK";
const string ON_DEFAULT_OBJECT_FAIL_TO_OPEN   = "ON_DEFAULT_OBJECT_FAIL_TO_OPEN";
const string ON_DEFAULT_OBJECT_MELEE_ATTACKED = "ON_DEFAULT_OBJECT_MELEE_ATTACKED";
const string ON_DEFAULT_OBJECT_OPENED         = "ON_DEFAULT_OBJECT_OPENED";
const string ON_DEFAULT_OBJECT_SPELLCASTAT    = "ON_DEFAULT_OBJECT_SPELLCASTAT";
const string ON_DEFAULT_OBJECT_TRAPTRIGGERED  = "ON_DEFAULT_OBJECT_TRAPTRIGGERED";
const string ON_DEFAULT_OBJECT_UNLOCK         = "ON_DEFAULT_OBJECT_UNLOCK";
const string ON_DEFAULT_OBJECT_USED           = "ON_DEFAULT_OBJECT_USED";


const string ON_AFTER_PC_ELC              = "NWNX_ON_ELC_VALIDATE_CHARACTER_AFTER";
const string ON_BEFORE_PC_ELC             = "NWNX_ON_ELC_VALIDATE_CHARACTER_BEFORE";
const string ON_BEFORE_PLAYER_REST        = "ON_BEFORE_PLAYER_REST";
const string ON_DEFAULT_PC_LEVELUP        = "ON_DEFAULT_PC_LEVELUP";
const string ON_AFTER_PC_LEVELUP          = NWNX_ON_LEVEL_UP_AFTER;
const string ON_DEFAULT_PC_DEATH          = "ON_DEFAULT_PC_DEATH";
const string ON_DEFAULT_PC_DYING          = "ON_DEFAULT_PC_DYING";
const string ON_DEFAULT_PC_REST           = "ON_DEFAULT_PC_REST";
const string ON_DEFAULT_PC_RESPAWN        = "ON_DEFAULT_PC_RESPAWN";
const string ON_DEFAULT_PC_REST_START     = "ON_DEFAULT_PC_REST_START";
const string ON_DEFAULT_PC_REST_CANCELLED = "ON_DEFAULT_PC_REST_CANCELLED";
const string ON_DEFAULT_PC_REST_STOP      = "ON_DEFAULT_PC_REST_STOP";

const string ON_DEFAULT_PC_SKIN_EQUIPPED  = "ON_DEFAULT_PC_SKIN_EQUIPPED"; // manually sent

const string ON_AFTER_PLACEABLE_CLOSE     = NWNX_ON_PLACEABLE_CLOSE_AFTER;
const string ON_BEFORE_PLACEABLE_OPEN     = NWNX_ON_PLACEABLE_OPEN_BEFORE;

const string ON_DEFAULT_PLAYER_CHAT      = "ON_DEFAULT_PLAYER_CHAT";
const string ON_DEFAULT_PLAYER_CHAT_HELP = "ON_DEFAULT_PLAYER_CHAT_HELP"; // manually sent
const string ON_DEFAULT_PLAYER_GUIEVENT  = "ON_DEFAULT_PLAYER_GUIEVENT";


//! @var ON_REALTIME_DAY
//! @brief Sent every 24 realtime hours
const string ON_REALTIME_DAY = "ON_REALTIME_DAY";

//! @var ON_REALTIME_HOUR
//! @brief Sent every realtime hour
const string ON_REALTIME_HOUR = "ON_REALTIME_HOUR";

//! @var ON_REALTIME_MINUTE
//! @brief Sent every realtime minute
const string ON_REALTIME_MINUTE = "ON_REALTIME_MINUTE";

const string ON_RESOURCE_ADDED    = "NWNX_ON_RESOURCE_ADDED";
const string ON_RESOURCE_MODIFIED = "NWNX_ON_RESOURCE_MODIFIED";
const string ON_RESOURCE_REMOVED  = "NWNX_ON_RESOURCE_REMOVED";

const string ON_DEFAULT_STORE_CLOSED = "ON_DEFAULT_STORE_CLOSED";
const string ON_DEFAULT_STORE_OPENED = "ON_DEFAULT_STORE_OPENED";
const string ON_AFTER_STORE_SELL     = NWNX_ON_STORE_REQUEST_SELL_AFTER;
const string ON_AFTER_STORE_BUY      = NWNX_ON_STORE_REQUEST_BUY_AFTER;

const string ON_DEFAULT_TRIGGER_ENTER = "ON_DEFAULT_TRIGGER_ENTER";
const string ON_DEFAULT_TRIGGER_EXIT  = "ON_DEFAULT_TRIGGER_EXIT";