On this page
JavaScript API
variables
Runtime variable object merged from config defaults and db storage.
The variables global is a plain object containing resolved variable values for the current execution context.
What it contains
At runtime, the runner merges:
config.globalVariablesdefaults- Stored global values from the database
- Scoped values for the current user/guild/channel/message context
console.log(variables.coins);
console.log(variables.welcomeMessage);
Aliases
Each registered variable is accessible under multiple keys:
- The storage key (e.g.
coins) - The reference key from variable definitions
- A
bc_prefixed alias (e.g.bc_coins)
Relationship to db.*
Writing through db.user.set(), db.global.set(), etc. updates variables in-place for the current context, so reads from variables reflect recent writes within the same script execution.
await db.user.set('coins', 100);
console.log(variables.coins); // 100
Variable registration
Variables must be registered in the Bot Creator app panel before scoped db.*.get() returns stored values. See the Database variables guide.
BDFD equivalent
BDScript uses $getUserVar, $getVar, etc. See Variables function category.
Related
- db — Storage API
- Events & placeholders —
((...))template variables