SpeechOptions

SpeechData

Data structure for speech playback.

• speechName: string

  • Base speech name

• character: CharacterName

  • The AI character to use

• addressal Addressal

  • Player's gender preference for speech

• isNetworked?: boolean

  • Whether to play speech for nearby players

• location? LocationInput

  • Optional location for speech playback

---

CharacterName

Valid character names string

• 'angel'

• 'haviland'

• 'og'

---

Addressal

Valid addressals string

• 'male'

• 'female'

---

LocationInput

Valid locations to use for speech playback param

• nil

  • Player ped coordinates (default)

• vector3

  • Direct world coordinates e.g. vector3(100, 200, 30)

• number

  • Entity handle - gets the entity's coordinates

• string

  • Relative to player: 'above', 'below', 'front', 'behind', 'left', 'right'

• {x, y, z}

  • Offset from player position e.g. {0, 0, 2}