Say

Easily speak to your carter character

You can speak to your carter agent using Carter.say(). Carter.say() returns a CarterInteraction.

// Assuming you have already created a Carter object called carter

const options = {
  uuid: "A UNIQUE USER ID" // Optional
  scene: "level-1" // Optional
}

// Send a message to your Carter agent
const interaction = await carter.say("Hello", 'your-player-id', speak=True) // Only the message is mandatory
if (interaction.ok) {
  const replyMessage = interaction.outputText
}

say() takes in your message and an optional playerId. carter-js will generate an id for you if you do not provide one. This will be different each time but can be extracted from the interaction object. speak is discussed in the Speak section.

Interactions

Carter interactions are discussed more in the next section, however please be aware that if Carter does not return a valid response then the carterData and outputText/outputAudio properties of the interaction will be null.