Interface ISayConfig

Configuration for how speech is rendered.

Inherited Members
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
Namespace: AGS.API
Assembly: AGS.API.dll
Syntax
public interface ISayConfig : INotifyPropertyChanged

Properties

| Improve this Doc View Source

BackgroundColor

Gets or sets the color of the text label's background (the default is transparent).

Declaration
Color BackgroundColor { get; set; }
Property Value
Type Description
Color

The color of the background.
| Improve this Doc View Source

Border

Gets or sets an optional border which will surround the label hosting the text.

Declaration
IBorderStyle Border { get; set; }
Property Value
Type Description
IBorderStyle

The border.
| Improve this Doc View Source

LabelSize

Gets or sets the size of the label which will host the text: default is (250, 200).

Declaration
SizeF LabelSize { get; set; }
Property Value
Type Description
SizeF

The size of the label.
| Improve this Doc View Source

PortraitConfig

A configuration for rendering a portrait. If this is null, no portrait will be rendered.

Declaration
IPortraitConfig PortraitConfig { get; set; }
Property Value
Type Description
IPortraitConfig

The portrait config.
| Improve this Doc View Source

SkipText

Determines how to skip the said text- by time, mouse, both (the default) or a custom implementation.

Declaration
SkipText SkipText { get; set; }
Property Value
Type Description
SkipText

The skip text.
| Improve this Doc View Source

TextConfig

Configuration for how the text is rendered (font, color, outlines, etc).

Declaration
ITextConfig TextConfig { get; set; }
Property Value
Type Description
ITextConfig

The text config.
| Improve this Doc View Source

TextDelay

When SkipText is configured to be either ByTime or ByTimeAndMouse then the engine estimates how long to keep the said text on the screen before moving on. This property determines how long (in milliseconds) should the engine wait for each character in the text (and 40 milliseconds overall are added on top of that to avoid too short sentences ending abruptly). The default for this value is 70 milliseconds.

Declaration
int TextDelay { get; set; }
Property Value
Type Description
System.Int32

The text delay.
Examples

If the character says "Hello, world!" and TextDelay = 70, then the amount of the time the engine waits will be: 40 + number of characters * 70 = 40 + 13 * 70 = 950 (milliseconds).

| Improve this Doc View Source

TextOffset

An optional offset for rendering the text from the planned location.

Declaration
PointF TextOffset { get; set; }
Property Value
Type Description
PointF

The text offset.