Interface IDialogFactory

A factory to create dialogs and dialog options.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IDialogFactory

Methods

GetDialog(String, Single, Single, IObject, Boolean, IDialogOption[])

Creates a new dialog.

Declaration

IDialog GetDialog(string id, float x = 0F, float y = 0F, IObject graphics = null, bool showWhileOptionsAreRunning = false, params IDialogOption[] options)

Parameters

Type	Name	Description
System.String	id	A unique id for the dialog.
System.Single	x	The x coordinate of the dialog left side.
System.Single	y	The y coordinate of the dialog bottom side.
IObject	graphics	The background graphic object of the dialog.
System.Boolean	showWhileOptionsAreRunning	Should the dialog be displayed while the characters are speaking?
IDialogOption[]	options	The list of dialog options to display.

Returns

Type	Description
IDialog	The new dialog.

GetDialogOption(String, ITextConfig, ITextConfig, ITextConfig, Boolean, Boolean)

Creates a dialog option.

Declaration

IDialogOption GetDialogOption(string text, ITextConfig config = null, ITextConfig hoverConfig = null, ITextConfig hasBeenChosenConfig = null, bool speakOption = true, bool showOnce = false)

Parameters

Type	Name	Description
System.String	text	The text that appears in the dialog option.
ITextConfig	config	Configuration for how to render the text.
ITextConfig	hoverConfig	Configuration for how to render the text when the mouse is hovering it.
ITextConfig	hasBeenChosenConfig	Configuration for how to render the text when it was already previously selected. If showOnce is true, the option will be hidden and this configuration is irrelevant.
System.Boolean	speakOption	Should the character say the option after the user selects it?
System.Boolean	showOnce	Should the engine hide the option after selecting it once?

Returns

Type	Description
IDialogOption	The new dialog option.