Class GuiDialog.DlgComposers

Namespace

Vintagestory.API.Client

Assembly

VintagestoryAPI.dll

Dialogue Composer for the GUIDialogue.

public class GuiDialog.DlgComposers : IEnumerable<KeyValuePair<string, GuiComposer>>, IEnumerable

Inheritance

object

GuiDialog.DlgComposers

Implements

IEnumerable<KeyValuePair<string, GuiComposer>>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EnumerableExtensions.Foreach<T>(IEnumerable<T>, Action<T>)

EnumerableExtensions.NearestDistance<T>(IEnumerable<T>, Func<T, double>)

EnumerableExtensions.Nearest<T>(IEnumerable<T>, Func<T, double>)

Constructors

DlgComposers(GuiDialog)

Constructor.

public DlgComposers(GuiDialog dialog)

Parameters

dialog GuiDialog

The dialogue this composer belongs to.

Fields

dialog

protected GuiDialog dialog

Field Value

GuiDialog

dialogComposers

protected OrderedDictionary<string, GuiComposer> dialogComposers

Field Value

OrderedDictionary<string, GuiComposer>

Properties

this[string]

Returns the composer for given composer name

public GuiComposer this[string key] { get; set; }

Parameters

key string

Property Value

GuiComposer

Values

Returns all composers as a flat list

public IEnumerable<GuiComposer> Values { get; }

Property Value

IEnumerable<GuiComposer>

Methods

ClearComposers()

Cleans up and clears the composers.

public void ClearComposers()

ContainsKey(string)

Checks to see if the key is located within the given dialogue composer.

public bool ContainsKey(string key)

Parameters

key string

The key you are searching for.

Returns

bool

Do we have your key?

Dispose()

Clean disposal method.

public void Dispose()

Remove(string)

Removes the given key and the corresponding value from the Dialogue Composer.

public void Remove(string key)

Parameters

key string

The Key to remove.