Table of Contents

Class HudElement

Namespace
Vintagestory.API.Client
Assembly
VintagestoryAPI.dll

Base class for Hud Elements.

public abstract class HudElement : GuiDialog, IDisposable
Inheritance
HudElement
Implements
Inherited Members

Constructors

HudElement(ICoreClientAPI)

Creates a new Hud Element.

public HudElement(ICoreClientAPI capi)

Parameters

capi ICoreClientAPI

The Client API

Properties

DialogType

Is this dialogue a dialogue or a HUD object?

public override EnumDialogType DialogType { get; }

Property Value

EnumDialogType

PrefersUngrabbedMouse

Gets whether it is preferred for the mouse to be not grabbed while this dialog is opened. If true (default), the Alt button needs to be held to manually grab the mouse.

public override bool PrefersUngrabbedMouse { get; }

Property Value

bool

ToggleKeyCombinationCode

The key combination string that toggles this GUI object.

public override string ToggleKeyCombinationCode { get; }

Property Value

string

Methods

OnRenderGUI(float)

This runs when the dialogue is ready to render all of the components.

public override void OnRenderGUI(float deltaTime)

Parameters

deltaTime float

The time that has elapsed.