Table of Contents

Class GuiElementElementListPickerBase<T>

Namespace
Vintagestory.API.Client
Assembly
VintagestoryAPI.dll

Creates a toggle button for the GUI.

public abstract class GuiElementElementListPickerBase<T> : GuiElementControl, IDisposable

Type Parameters

T
Creates a toggle button for the GUI.
Inheritance
GuiElementElementListPickerBase<T>
Implements
Derived
Inherited Members

Constructors

GuiElementElementListPickerBase(ICoreClientAPI, T, ElementBounds)

Constructor for the button

public GuiElementElementListPickerBase(ICoreClientAPI capi, T elem, ElementBounds bounds)

Parameters

capi ICoreClientAPI

The core client API.

elem T
bounds ElementBounds

The bounding box of the button.

Fields

On

Is this button on?

public bool On

Field Value

bool

ShowToolTip

public bool ShowToolTip

Field Value

bool

handler

public Action<bool> handler

Field Value

Action<bool>

Properties

Focusable

Is this element capable of being in the focus?

public override bool Focusable { get; }

Property Value

bool

TooltipText

public string TooltipText { set; }

Property Value

string

Methods

ComposeElements(Context, ImageSurface)

Composes the element in both the pressed, and released states.

public override void ComposeElements(Context ctx, ImageSurface surface)

Parameters

ctx Context

The context of the element.

surface ImageSurface

The surface of the element.

Remarks

Neither the context, nor the surface is used in this function.

Dispose()

Disposes of the button.

public override void Dispose()

DrawElement(T, Context, ImageSurface)

public abstract void DrawElement(T elem, Context ctx, ImageSurface surface)

Parameters

elem T
ctx Context
surface ImageSurface

OnMouseDownOnElement(ICoreClientAPI, MouseEvent)

Handles the mouse button press while the mouse is on this button.

public override void OnMouseDownOnElement(ICoreClientAPI api, MouseEvent args)

Parameters

api ICoreClientAPI

The client API

args MouseEvent

The mouse event arguments.

OnMouseUp(ICoreClientAPI, MouseEvent)

Handles the event fired when the mouse is released.

public override void OnMouseUp(ICoreClientAPI api, MouseEvent args)

Parameters

api ICoreClientAPI

The client API

args MouseEvent

Mouse event arguments

OnMouseUpOnElement(ICoreClientAPI, MouseEvent)

Handles the mouse button release while the mouse is on this button.

public override void OnMouseUpOnElement(ICoreClientAPI api, MouseEvent args)

Parameters

api ICoreClientAPI

The client API

args MouseEvent

The mouse event arguments

RenderInteractiveElements(float)

Renders the button.

public override void RenderInteractiveElements(float deltaTime)

Parameters

deltaTime float

The time elapsed.

SetValue(bool)

Sets the value of the button.

public void SetValue(bool on)

Parameters

on bool

Am I on or off?