Interface IDialog

Represents a dialog (an on-going conversation) between two (or more) characters. The dialog is structured as a sequence of actions (usually the characters talking), followed by a list of choices for the player, where each choice branches to another sequence of actions, followed by another list of choices, and so on.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IDialog

Properties

| Improve this Doc View Source

Graphics

The background graphics for the dialog.

Declaration

IObject Graphics { get; }

Property Value

Type	Description
IObject	The graphics.

| Improve this Doc View Source

Options

Gets the list of options for the user to choose from.

Declaration

IList<IDialogOption> Options { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IDialogOption>	The options.

| Improve this Doc View Source

ShowWhileOptionsAreRunning

Gets a value indicating whether this IDialog should show while the actions triggered by the selected option are running.

Declaration

bool ShowWhileOptionsAreRunning { get; }

Property Value

Type	Description
System.Boolean	`true` if show while options are running; otherwise, `false`.

| Improve this Doc View Source

StartupActions

Gets the startup actions (will be performed before the dialog options are shown to the user).

Declaration

IDialogActions StartupActions { get; }

Property Value

Type	Description
IDialogActions	The startup actions.

Methods

| Improve this Doc View Source

AddOptions(IDialogOption[])

Adds the specified options to the user's list of choices.

Declaration

void AddOptions(params IDialogOption[] options)

Parameters

Type	Name	Description
IDialogOption[]	options	Options.

| Improve this Doc View Source

RunAsync()

Run the dialog asynchronously. This will run the StartupActions, followed by showing the Options

Declaration

Task RunAsync()

Returns

Type	Description
System.Threading.Tasks.Task