Events provide passive listening and alternative registration paths for the voice system. Use exports for active control (register, enable, query). Use events for observing what is happening — lifecycle notifications, transcript monitoring, and cross-resource coordination.
| Use case | Recommended |
|---|---|
| Register an action with a callback | RegisterAction global or registerAction export |
| Register an action from a UI resource that has no client script | TriggerEvent('onex-voiceInteraction:action:register', ...) |
| React to any command execution (logging, analytics) | AddEventHandler('onex-voiceInteraction:command:executed', ...) |
| Monitor raw speech before matching | AddEventHandler('voicesdk:onTranscript', ...) |
| Detect when no command matched | AddEventHandler('onex-voiceInteraction:noMatch', ...) |
Fires when any action is successfully registered.
Your Script
| Argument | Type | Description |
|---|---|---|
name | string | Action name |
sourceResource | string | Resource that registered it |
Fires when an action is unregistered.
Your Script
| Argument | Type | Description |
|---|---|---|
target | string | Action name or @resource_name pattern that was unregistered |
Fires when a single action's enabled state changes.
Your Script
| Argument | Type | Description |
|---|---|---|
actionName | string | Action name |
enabled | boolean | New enabled state |
Fires when a group is enabled or disabled via setActionEnabled("#group_name", ...).
Your Script
| Argument | Type | Description |
|---|---|---|
groupName | string | Group name |
enabled | boolean | New enabled state |
Fires when setActionEnabled("*", true) clears all disabled states, restoring all actions.
Your Script
No arguments.
Fires every time a voice command matches and executes. Useful for logging, analytics, or triggering secondary side-effects.
Your Script
| Argument | Type | Description |
|---|---|---|
name | string | Action name |
def | table | Full action definition |
score | number | Match score (0.0–1.0) |
tier | number | Matching tier used (1–4) |
transcript | string | Recognized speech text |
confidence | number | STT confidence (0.0–1.0) |
extractedVars | table | Variables extracted from {placeholder} phrases |
Fires when speech was recognized but no action matched.
Your Script
| Field | Type | Description |
|---|---|---|
data.transcript | string | The unmatched speech text |
data.confidence | number | STT confidence of the transcript |
data.enabledGroups | table | List of currently enabled group names at time of no-match |
Fires when the microphone begins recording. Useful for UI feedback such as showing a recording indicator.
Your Script
No arguments.
Fires when an internal system error occurs.
Your Script
| Argument | Type | Description |
|---|---|---|
errorType | string | Error category identifier |
errorMessage | string | Human-readable error description |
Fires before command matching — every time the STT engine produces a transcript. Useful for debugging, building custom matching logic, or displaying live captions.
Your Script
| Argument | Type | Description |
|---|---|---|
transcript | string | Raw recognized speech text |
confidence | number | STT confidence (0.0–1.0) |
Fires when TTS playback begins.
Your Script
| Argument | Type | Description |
|---|---|---|
text | string | Text being spoken |
Fires when TTS playback finishes naturally.
Your Script
| Argument | Type | Description |
|---|---|---|
text | string | Text that was spoken |
Fires when TTS playback is stopped early via stopSpeech().
Your Script
No arguments.
Fires when TTS synthesis or playback fails.
Your Script
| Argument | Type | Description |
|---|---|---|
errorType | string | Error category |
text | string | Text that failed to play |
Fires when the voice list is available from the browser engine. Used internally by getVoices() when called without a callback.
Your Script
| Argument | Type | Description |
|---|---|---|
voices | table[] | Array of available voice objects from the browser TTS engine |
Fires when a 3D positional audio sound begins playing.
Your Script
| Argument | Type | Description |
|---|---|---|
soundId | string | Sound identifier |
Fires when a 3D positional audio sound finishes.
Your Script
| Argument | Type | Description |
|---|---|---|
soundId | string | Sound identifier |
entity | number | nil | Ped entity the sound was attached to, or nil for global sounds |
Fires when a 3D positional audio sound fails.
Your Script
| Argument | Type | Description |
|---|---|---|
soundId | string | Sound identifier |
error | string | Error description |
entity | number | nil | Ped entity the sound was attached to, or nil for global sounds |
All three action management exports have event equivalents. Use these when calling from a resource that does not have a persistent client script context (e.g. a UI frame resource).
Your Script
If registration fails, onex-voiceInteraction:action:register-failed fires with the action name and error message.
Your Script
Your Script
Your Script
RegisterAction is a global function available within the same resource as the voice system scripts. It is functionally identical to the registerAction export but is required when the action's callback must reference Lua closures in the current scope.
Lua callbacks do not survive export boundaries. If your trigger uses callback = function(data) ... end, and that function references upvalues in the same file, use RegisterAction — not the export.
Your Script
Your Script
RegisterAction is only available in the same resource. Use the export or event form from other resources.
Last updated 3 months ago