Define custom NPCs at fixed world coordinates and map voice commands to any server event, client event, or export. Each NPC gets its own set of recognized phrases, voice settings, and an optional secret word.
NPCInteractConfig.enabled#| Type | Default |
|---|---|
boolean | true |
Master toggle for the NPC interact addon.
NPCInteractConfig.debug#| Type | Default |
|---|---|
boolean | false |
Enable debug logging. Set to false in production.
NPCInteractConfig.defaultRadius#| Type | Default |
|---|---|
number | 5.0 |
Default interaction radius in meters. Applied to all NPCs unless overridden per NPC.
NPCInteractConfig.defaultFirstTalk#| Type | Default |
|---|---|
boolean | false |
When true, the NPC automatically greets the player when they enter the detection radius.
NPCInteractConfig.defaultFirstTalkDelay#| Type | Default |
|---|---|
number | 0 |
Delay in milliseconds before the NPC delivers its automatic greeting.
NPCInteractConfig.defaultAnimation#Animation defaults applied to all NPCs unless overridden per NPC.
| Field | Type | Default | Description |
|---|---|---|---|
lipSync | boolean | true | Enable lip sync animation during speech |
gesture | boolean | true | Enable hand gesture animation |
returnToIdle | boolean | true | Return to idle animation after speaking |
idleScenario | string | "WORLD_HUMAN_STAND_IMPATIENT" | GTA scenario played when NPC is idle |
NPCInteractConfig.defaultAnimation = { lipSync = true, gesture = true, returnToIdle = true, idleScenario = "WORLD_HUMAN_STAND_IMPATIENT", }
Last updated 14 days ago