Class PluginHudDescriptor

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Stable metadata used to create a plugin-owned overlay.

public sealed record PluginHudDescriptor : IEquatable<PluginHudDescriptor>

Inheritance

object

PluginHudDescriptor

Implements

IEquatable<PluginHudDescriptor>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

No client draws overlays yet: every host answers with NoOpPluginRenderRegistry. The unit and origin of every position and size in this file are fixed by the first client that does.

Constructors

PluginHudDescriptor(string, string, PluginHudBounds, bool, bool, bool, bool, int)

Stable metadata used to create a plugin-owned overlay.

public PluginHudDescriptor(string Id, string Title, PluginHudBounds DefaultBounds, bool Visible = true, bool Movable = true, bool Resizable = true, bool ClickThrough = false, int Layer = 0)

Parameters

Id string

The overlay's name, unique within the plugin that adds it.

Title string

The name shown to the player for this overlay.

DefaultBounds PluginHudBounds

Where the overlay sits, and how large it is, until the player or the plugin moves it.

Visible bool

Whether the overlay starts out shown.

Movable bool

Whether the player may drag the overlay.

Resizable bool

Whether the player may resize the overlay.

ClickThrough bool

When true, pointer input passes through the overlay to whatever is under it, and the overlay receives none.

Layer int

Drawing order among overlays: a higher layer is drawn over a lower one.

Remarks

No client draws overlays yet: every host answers with NoOpPluginRenderRegistry. The unit and origin of every position and size in this file are fixed by the first client that does.

Properties

ClickThrough

When true, pointer input passes through the overlay to whatever is under it, and the overlay receives none.

public bool ClickThrough { get; init; }

Property Value

bool

DefaultBounds

Where the overlay sits, and how large it is, until the player or the plugin moves it.

public PluginHudBounds DefaultBounds { get; init; }

Property Value

PluginHudBounds

Id

The overlay's name, unique within the plugin that adds it.

public string Id { get; init; }

Property Value

string

Layer

Drawing order among overlays: a higher layer is drawn over a lower one.

public int Layer { get; init; }

Property Value

int

Movable

Whether the player may drag the overlay.

public bool Movable { get; init; }

Property Value

bool

Resizable

Whether the player may resize the overlay.

public bool Resizable { get; init; }

Property Value

bool

Title

The name shown to the player for this overlay.

public string Title { get; init; }

Property Value

string

Visible

Whether the overlay starts out shown.

public bool Visible { get; init; }

Property Value

bool