Class TerminalDragBox

Namespace

RichHudFramework.UI.Client

Assembly

RichHudClient.dll

A control allowing the user to visually select a 2D screen position (Vector2) for a ControlTile.

Spawns a temporary draggable window when interacted with. Useful for configuring HUD element positions.

public class TerminalDragBox : TerminalValue<Vector2>

Inheritance

object

TerminalControlBase

TerminalValue<Vector2>

TerminalDragBox

Inherited Members

Value

CustomValueGetter

ControlChanged

ControlChangedHandler

Name

Enabled

ToolTip

Examples

new TerminalDragBox()
{
    Name = "TerminalDragBox",
    ControlChangedHandler = (obj, args) =>
    {
        var box = obj as TerminalDragBox;
        ExceptionHandler.SendChatMessage($"New box position: {box.Value}");
    },
    ToolTip = "Spawns a draggable window for setting fixed position on the HUD.\nUseful for user-configurable" +
    " UI layout."
}

Constructors

TerminalDragBox()

public TerminalDragBox()

Properties

AlignToEdge

If true, the window aligns itself to the nearest screen edge.

public bool AlignToEdge { get; set; }

Property Value

bool

BoxSize

The size of the draggable window spawned by this control.

public Vector2 BoxSize { get; set; }

Property Value

Vector2