Class HudElementContainer<TElement>

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Standard container class for HudChain<TElementContainer, TElement> members.

public class HudElementContainer<TElement> : IChainElementContainer<TElement>, IHudNodeContainer<TElement> where TElement : HudElementBase

Type Parameters

TElement

UI element type used for the entry

Inheritance

object

HudElementContainer<TElement>

Implements

IChainElementContainer<TElement>

IHudNodeContainer<TElement>

Derived

HudElementContainer

HudElementTuple<TElement, TData>

ScrollBoxEntry<TElement>

SelectionBoxEntry<TElement>

Constructors

HudElementContainer()

public HudElementContainer()

Properties

AlignAxisScale

Determines how excess space in the HudChain is distributed along the alignment axis.

0f = The element retains its fixed size (default behavior).

> 0f = The element scales proportionally relative to the sum of all weighted elements to fill remaining space.

Note: This value is ignored if the Chain is using FitMembersAlignAxis.

public float AlignAxisScale { get; set; }

Property Value

float

Element

The HUD Element associated with this container.

public virtual TElement Element { get; protected set; }

Property Value

TElement

Methods

SetElement(TElement)

Sets the element associated with the container.

This method should only allow a single assignment to ensure immutability of the link.

public virtual void SetElement(TElement element)

Parameters

element TElement