ff_i_consts

Constants.

MODULE_START_TIMESTAMP

Time when the module itself started, in seconds starting from Jan 1, 1970.

NWN_CLEAR_CONSOLE

If TRUE, then the server will clear the console on module start. Default: True.

NWN_DEBUG

Environment variable to set module in debug mode.

NWN_SHUTDOWN

If TRUE, then the server will shutdown right after loading. Useful for running only the verify startup sequence.

SERVER_START_TIMESTAMP

Time when the server started, in seconds starting from Jan 1, 1970.

SCRIPT_EMPTY

Empty string script (“”). Used when scripts are no longer needed.

SCRIPT_NULL

Null script to avoid replacing a script with the on event scripts.

SCRIPT_ON_EVENT

Default script to run an event.

SCRIPT_ON_CONSOLE

Default script to run a console event.

TAG_BODY_BAG

Name of item after NPC death.

TAG_REMAINS

Name of item after NPC death.

TLK_OFFSET

TLK offset for custom strings.

NWNX_UTIL_RESREF_TYPE_MODULE

NWNX_UTIL_RESREF_TYPE_PALETTE

NWNX_UTIL_RESREF_TYPE_AREA_GIC

GUI_PANEL_RADIAL_MENU

CACHE_PREFIX

Prefix used for cached values.

NW_L_FEEDBACK

Used to get feedback ID to show to PC.

OP

Used commonly in dialog script.

PC

Used to pass data from script to script.

RETVAL

Used to pass data from script to script.

VARIABLE

Used to pass a variable in dialog scripts.

VALUE

Used to pass a variable in dialog scripts.

Source code

// @code

#include "x2_inc_switches"

// -----------------------------------------------------------------------------
// Core constants

//! @var MODULE_START_TIMESTAMP
//! @brief Time when the module itself started, in seconds starting from Jan 1, 1970
const string MODULE_START_TIMESTAMP = "__MODULE_START_TIMESTAMP";

//! @var NWN_CLEAR_CONSOLE
//! @brief If TRUE, then the server will clear the console on module start. Default: True
const string NWN_CLEAR_CONSOLE = "NWN_CLEAR_CONSOLE";

//! @var NWN_DEBUG
//! @brief Environment variable to set module in debug mode
const string NWN_DEBUG = "NWN_DEBUG";

//! @var NWN_SHUTDOWN
//! @brief If TRUE, then the server will shutdown right after loading. Useful for running only the verify startup sequence.
const string NWN_SHUTDOWN = "NWN_SHUTDOWN";

//! @var SERVER_START_TIMESTAMP
//! @brief Time when the server started, in seconds starting from Jan 1, 1970
const string SERVER_START_TIMESTAMP = "__SERVER_START_TIMESTAMP";

//! @var SCRIPT_EMPTY
//! @brief Empty string script (""). Used when scripts are no longer needed.
const string SCRIPT_EMPTY = "";

//! @var SCRIPT_NULL
//! @brief Null script to avoid replacing a script with the on event scripts
const string SCRIPT_NULL = "null";

//! @var SCRIPT_ON_EVENT
//! @brief Default script to run an event
const string SCRIPT_ON_EVENT = "on_event";

//! @var SCRIPT_ON_CONSOLE
//! @brief Default script to run a console event
const string SCRIPT_ON_CONSOLE  = "on_console";

//! @var TAG_BODY_BAG
//! @brief Name of item after NPC death
const string TAG_BODY_BAG  = "BodyBag";

//! @var TAG_REMAINS
//! @brief Name of item after NPC death
const string TAG_REMAINS  = "Remains";

//! @var TLK_OFFSET
//! @brief TLK offset for custom strings
const int TLK_OFFSET = 16777216;


// -----------------------------------------------------------------------------
// Missing constants

const int NWNX_UTIL_RESREF_TYPE_MODULE = 2014;
const int NWNX_UTIL_RESREF_TYPE_PALETTE = 2030;
const int NWNX_UTIL_RESREF_TYPE_AREA_GIC = 2046;

const int GUI_PANEL_RADIAL_MENU = 26;

// -----------------------------------------------------------------------------

//! @var CACHE_PREFIX
//! @brief Prefix used for cached values
const string CACHE_PREFIX = "__CACHE_";

//! @var NW_L_FEEDBACK
//! @brief Used to get feedback ID to show to PC
// cf. nw_all_feedback
const string NW_L_FEEDBACK = "NW_L_FEEDBACK";

//! @var OP
//! @brief Used commonly in dialog script
// cf. nw_all_feedback
const string OP = "OP";

//! @var PC
//! @brief Used to pass data from script to script
// cf. nw_all_feedback
const string PC = "PC";

//! @var RETVAL
//! @brief Used to pass data from script to script
const string RETVAL = "RETVAL";

//! @var VARIABLE
//! @brief Used to pass a variable in dialog scripts
// cf. nw_all_feedback
const string VARIABLE = "VARIABLE";

//! @var VALUE
//! @brief Used to pass a variable in dialog scripts
// cf. nw_all_feedback
const string VALUE = "VALUE";