DirkScripts
Docs
Exports
#setCharacterState
Apply one of the configured Character States to a specific character.
luaexports.dirk_multichar:setCharacterState(charId, stateName, payload?)
| Argument | Type | Purpose |
|---|---|---|
charId | string | The internal character ID. |
stateName | string | Must match one of the states configured in the States tab of the Live Script Configurator. |
payload | table? | Optional extra data shown to the player alongside the state (e.g. { endsAt = os.time() + 900 } for a timed state). |
#registerLifestyle
Register a Lua-side lifestyle at runtime. Useful when an external resource wants to surface its own lifestyle entries without admins manually adding them to the configurator.
luaexports.dirk_multichar:registerLifestyle('mylifestyle', { label = 'My Lifestyle', description = 'A short description for the player.', items = { { name = 'phone', amount = 1 }, { name = 'wallet', amount = 1 }, }, -- additional fields mirror what's in the configurator's Lifestyles tab })
| Argument | Type | Purpose |
|---|---|---|
id | string | Unique key for the lifestyle. Used internally to reference the entry. |
data | table | Lifestyle definition matching the configurator's data shape. |
Registered lifestyles appear in the player's lifestyle picker alongside admin-configured ones.
The scriptConfig system itself is read from external code via
lib.scriptConfig.get('section')andlib.scriptConfig.on('section', cb). See dirk_lib's scriptConfig docs for the full API.