Table of Contents

Class GuiDialogGeneric

Namespace
Vintagestory.API.Client
Assembly
VintagestoryAPI.dll

Mainly used for block entity based guis

public abstract class GuiDialogGeneric : GuiDialog, IDisposable
Inheritance
GuiDialogGeneric
Implements
Derived
Inherited Members

Constructors

GuiDialogGeneric(string, ICoreClientAPI)

Constructor for a generic Dialog.

public GuiDialogGeneric(string DialogTitle, ICoreClientAPI capi)

Parameters

DialogTitle string

The title of the dialog.

capi ICoreClientAPI

The Client API

Fields

DialogTitle

The title of the Dialog.

public string DialogTitle

Field Value

string

Properties

Attributes

The tree attributes for this dialog.

public virtual ITreeAttribute Attributes { get; protected set; }

Property Value

ITreeAttribute

ToggleKeyCombinationCode

The key combination string that toggles this GUI object.

public override string ToggleKeyCombinationCode { get; }

Property Value

string

UnregisterOnClose

Should this Dialog de-register itself once closed?

public override bool UnregisterOnClose { get; }

Property Value

bool

Methods

FocusElement(int)

Focuses a specific element in the single composer.

public virtual void FocusElement(int index)

Parameters

index int

Index of the element.

IsInRangeOfBlock(BlockPos)

Checks if the player is in range of the block.

public virtual bool IsInRangeOfBlock(BlockPos blockEntityPos)

Parameters

blockEntityPos BlockPos

The block's position.

Returns

bool

In range or no?

Recompose()

Recomposes the dialog with it's set of elements.

public virtual void Recompose()

UnfocusElements()

Unfocuses the elements in each composer.

public virtual void UnfocusElements()