Conversation

Conversation Tools

Convert Integer To Conversation State Index

• Returns the conversation state index for the given conversation state and integer index.

Remove Conversation

• Removes a conversation.

Remove All Conversations

• Removes all conversations.

Remove Conversation Reply

• Removes a reply from a conversation.

Remove All Conversation Replies

• Removes all replies from a conversation.

Conversation Reply Index

• Returns the index of the specified conversation reply.

Conversation Reply State

• Returns the reply state for the specified conversation reply.

Conversation Reply Text

• Returns the text of the specified conversation reply.

Mark Conversation Reply As Read/Unread

• Marks a conversation reply as either read or unread.

Set Conversation Reply Text

• Sets the text for a conversation reply.

Conversations

Create Conversation

• Creates a conversation. Conversations can be used to create interactive character dialogue that allows a player to select from a list of replies. Conversations can be created purely through triggers, or created in data, and run via triggers.

Last Created Conversation

• Returns the last created conversation.

Create Conversation Reply

• Creates a conversation reply.

Last Created Conversation Reply

• Returns the last created conversation reply.

Show/Hide Conversation

• Shows or hides a conversation for a player group.

Conversation Is Visible

• Returns true if the conversation is visible for the specified player.

Selected Conversation

• Returns the selected conversation.

Selected Conversation Reply

• Returns the selected conversation reply.

Data Conversation Tools

Active Data Conversation Camera

• Returns the state index for the last camera to be applied in the running data conversation

Active Data Conversation Sound

• Returns the sound associated with the active line in the running data conversation

Data Conversation Can Be Run

• Returns true if the conversation has any active lines or choices to be run using the current state.

Data Conversation Choice Count

• Returns the total number of choices defined in a conversation.

Data Conversation Choice Picked

• Returns the picked state of a conversation choice.

Data Conversation Choice Picked Count

• Returns the number of times a conversation choice has been picked.

Data Conversation Choice State

• Returns the reply state of a conversation choice.

Data Conversation Choice Name

• Returns the name of a conversation choice at the specified index.

Mark Data Conversation Choice As Picked/Unpicked

• Marks a conversation choice as either picked or unpicked.

Set Data Conversation Choice Picked Count

• Sets the picked count for a conversation choice.

Mark Data Conversation Choice As Read/Unread

• Marks a conversation choice as either read or unread.

Data Conversation Line Count

• Returns the total number of lines defined in a conversation.

Data Conversation Line Picked Count

• Returns the number of times a conversation line has been picked.

Data Conversation Line Name

• Returns the name of a conversation line at the specified index.

Set Data Conversation Line Picked Count

• Sets the picked count for a conversation line.

Load Data Conversation Lines And Choices

• Loads the picked states of all choices and lines for the given conversation from a bank section.

Load Data Conversation State Value

• Loads a specific conversation state value from a bank section.

Load Data Conversation State Values

• Loads all state values of the given conversation state from a bank section.

Preload Data Conversation Lines

• Preloads sound files for all lines available to be run within the given conversation.

Reset Data Conversation Lines And Choices

• Resets the picked states of all choices and lines for the given conversation back to the default unread state.

Reset Data Conversation State Values

• Resets all state values of the given conversation state back to zero.

Save Data Conversation Lines And Choices

• Saves the picked states of all choices and lines within the given conversation to a bank section.

Save Data Conversation State Value

• Saves a specific conversation state value to a bank section.

Save Data Conversation State Values

• Saves all state values within the given conversation state to a bank section.

Data Conversation State Ability Command

• Returns an ability command associated with the given conversation state. The info name corresponds with the 'Info Name' field defined in the state.

Data Conversation State Attachment Point

• Returns the attachment point associated with the given conversation state.

Data Conversation State Custom Value

• Returns a custom value associated with the given conversation state. The info name corresponds with the 'Info Name' field defined in the state.

Data Conversation State

• Converts a conversation state index to an integer.

Data Conversation State Text Tag Edge

• Returns the text tag edge associated with the given conversation state.

Data Conversation State Image

• Returns the image associated with the given conversation state.

Data Conversation State Count

• Returns the number of individual state values within a state definition.

Data Conversation State Model

• Returns a model associated with the given conversation state. The info name corresponds with the 'Info Name' field defined in the state.

Data Conversation State Movie

• Returns the movie associated with the given conversation state.

Data Conversation State Name

• Returns the display name of the given conversation state.

Data Conversation State Text

• Returns display text associated with the given conversation state. The text name corresponds with the 'Info Name' field defined in the state.

Data Conversation State Upgrade

• Returns an upgrade associated with the given conversation state. The info name corresponds with the 'Info Name' field defined in the state.

Data Conversations

Set Data Conversation Camera

• Sets a camera to be used and a trigger to be run when the specified camera state and character state are reached.

Set Data Conversation Portrait

• Sets a portrait to be used for a given character during data-driven conversations.

Set Data Conversation Unit

• Sets a conversation state to a unit.

Run Data Conversation

• Runs a conversation for the specified player group.

Set Data Conversation State

• Sets a conversation state to an integer.

Stop Data Conversation

• Stops the active conversation.

Triggering Conversation State

• Returns the conversation state in response to Data Conversation State Changed events.