NPCChat

This section is under construction, please inquire if you have API related questions that are not documented.

Conversation

Variable

Description

dialogueList

List of DialogueSettings, each index represents a page and it's settings.

numberOfPages

Defines the number of pages in the conversation, press update to apply changes.

DialogueSettings

Variable

Description

duration

Only visible when timedPages is enabled. The page will be closed after the duration.

name

Text displayed in the chat box name field.

text

Text displayed in the chat box text field.

chatBox

Chat box to use for the conversation page.

lipSyncData

(Requires LipSync Pro) Reference to a LipSyncData object for the conversation page, will be played on the page's LipSync reference.

lipSync

(Requires LipSync Pro) Reference to a LipSync object for the conversation page, will be played on the page's LipSync reference."

audio

Audio Clip to use for the conversation page.

loopAudio

Controls if the page audio clip should loop.

pageStartEvent

UnityEvent that is triggered when the page starts.

pageStopEvent

UnityEvent that is triggered when the page is closed.

Settings

Variable

Description

playOnAwake

Play the conversation when the scene loads.

delay

Amount of time to wait before the conversation is started through Play On Awake.

scrollingText

Print display text over time for each page.

speed

Controls the rate at which scrolling text is printed.

timedPages

Enables an option to set a 'Duration' for each page in the conversation settings.

chatStartEvent

Event that's triggered when the conversation is started.

chatStopEvent

Event that's triggered when the conversation ends.

useStartEvent

Controls if the Chat Start Event can be triggered.

useStopEvent

Controls if the Chat Stop Event can be triggered.

Last updated