Layers provide priority-based context management for voice commands. When a player enters a shop, bank, or minigame, only the commands relevant to that context are active. Global commands (system, emergency) always work regardless of context.
Only one custom layer can be active at a time.
| Layer | Priority | Exclusive | Always active | Description |
|---|---|---|---|---|
global | 100 | no | yes | System commands — always available when layer is enabled |
context | 50 | yes | no | Generic exclusive context for backward compatibility |
ambient | 10 | no | yes | Default commands when no custom layer is active |
The ambient layer auto-disables when an active custom layer has disableAmbient = true. The global layer is never auto-disabled by other layers.
Register a custom layer. Call once at resource start — layers persist until the resource stops.
Syntax
| Name | Type | Default | Description |
|---|---|---|---|
config.name | string | — | Unique layer identifier. Cannot be "global" or "ambient". |
config.priority | number | 50 | Higher values take precedence in conflict resolution. |
config.exclusive | boolean | true | When true, only one group can be active at a time within this layer. |
config.disableAmbient | boolean | true | Automatically disables the ambient layer when this layer is entered. |
config.disableLayers | string[] | {} | Other layer names to disable when this layer is entered. Restored on exit. |
config.promptHints | string[] | nil | STT vocabulary hints — words the engine will prioritize recognizing. |
config.proximityPriority | boolean | nil | Enable proximity-based layer yielding — the layer with the smallest reported distance wins conflicts. |
Returns: { success = true, data = { name = "shop" } }
Your Script
Activate a layer with a specific action group. Actions registered with group = groupName and layer = layerName become active.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Registered layer name |
groupName | string | Group name to activate — matches group on registered actions |
options.promptHints | string[] | Override the layer's registered STT hints for this session only |
options.customHints | table | Bypass automatic hint collection with explicit hint objects { name, phrase, layer? } |
Returns: { success = true, data = { layer = "shop", group = "voice_shop_liquor_1" } }
What happens internally:
disableLayersdisableAmbient = trueYour Script
Deactivate a layer and restore the state that existed before enterLayer was called.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name to exit |
Returns: { success = true, data = { layer = "shop" } }
What happens internally:
Your Script
Switch the active action group within an already-entered layer. Used for multi-step flows where different commands apply at different stages.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Active layer name — must be the currently active custom layer |
groupName | string | New group to activate |
Returns: { success = true, data = { layer = "banking", group = "voice_bank_confirm" } }
Your Script
Enable or disable a layer globally. Disabled layers cannot be entered.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name |
enabled | boolean | true to enable, false to disable |
Returns: { success = true, data = { layer = "npc_interact", enabled = false } }
Your Script
Update a layer's configuration at runtime. Only the provided fields are overwritten.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name |
config.priority | number | New priority value |
config.disableAmbient | boolean | Update ambient disable rule |
config.disableLayers | string[] | Replace the conflicting layers list |
Returns: { success = true, data = { layer = "shop" } }
Your Script
Override the visible voice hints for the current active session of a layer. Bypasses automatic hint collection from the action registry.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Active layer name |
hints | table[] | Array of hint objects { name, phrase, layer? } |
The layer must currently be active (enterLayer must have been called). Hints are cleared automatically on exitLayer.
Returns: { success = true, data = { layer = "shop", count = 2 } }
Your Script
Update the proximity distance for a layer registered with proximityPriority. The layer instance reporting the smallest distance wins activation conflicts against other proximity-priority layers of the same type.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name |
distance | number | nil | Distance to the nearest relevant entity, or nil to clear |
Returns: { success = true, data = { layer = "npc_interact" } }
Your Script
Check whether a layer should yield to a closer proximity competitor before entering. Returns true if another active layer with proximityPriority has a smaller reported distance. Use this before calling enterLayer to avoid overriding a closer NPC interaction.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name to check |
Returns: boolean
Your Script
Get the currently active custom layer and group.
Syntax
Returns: { success = true, data = { layer = "shop", group = "voice_shop_1" } } — data is nil if no custom layer is active.
Your Script
Get the full current state of a specific layer.
Syntax
| Name | Type | Description |
|---|---|---|
layerName | string | Layer name to inspect |
Returns: { success = true, data = { enabled, activeGroup, priority, exclusive, disableAmbient, disableLayers, disabledByProximity } }
| Field | Type | Description |
|---|---|---|
enabled | boolean | Whether the layer is currently enabled |
activeGroup | string | nil | Currently active group, or nil if not entered |
priority | number | Layer priority value |
exclusive | boolean | Whether the layer is exclusive |
disableAmbient | boolean | Whether this layer disables ambient when active |
disableLayers | string[] | Layers disabled when this one is entered |
disabledByProximity | boolean | true if disabled because a closer proximity-priority competitor is active |
Your Script
Get all registered layers and their current state.
Syntax
Returns: { success = true, data = { layers = { [name] = { enabled, activeGroup, priority, exclusive, disableAmbient, disableLayers } } } }
Your Script
When voice input arrives, the layer system filters which actions are eligible before matching:
| Action layer | Active when |
|---|---|
"global" | Always, as long as the layer itself is enabled |
"ambient" | No custom layer is active, or active layer has disableAmbient = false |
| custom exclusive | Is the current activeCustomLayer AND group matches activeGroup |
| custom non-exclusive | Layer is enabled AND group matches activeGroup |
Actions in disabled layers or non-matching groups are excluded before matching starts.
Your Script
Your Script
Your Script
Your Script
Last updated 3 months ago