Interface IHudCollection<TElementContainer, TElement>

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Mutable interface for HUD collections supporting decorator-wrapped child elements.

public interface IHudCollection<TElementContainer, TElement> : IReadOnlyHudCollection<TElementContainer, TElement>, IReadOnlyList<TElementContainer>, IReadOnlyCollection<TElementContainer>, IEnumerable<TElementContainer>, IEnumerable where TElementContainer : IHudNodeContainer<TElement>, new() where TElement : HudNodeBase

Type Parameters

TElementContainer

Type of the container/decorator wrapping each element. Must implement IHudNodeContainer<TElement>.

TElement

Actual HUD element type stored in each container.

Inherited Members

Collection

Find(Func<TElementContainer, bool>)

FindIndex(Func<TElementContainer, bool>)

this[int]

Count

GetEnumerator()

Methods

Add(TElementContainer)

Adds a pre-built container to the end of the collection.

void Add(TElementContainer container)

Parameters

container TElementContainer

Add(TElement)

Adds a raw element by automatically creating and inserting a new container.

void Add(TElement element)

Parameters

element TElement

AddRange(IReadOnlyList<TElementContainer>)

Adds multiple containers in a single batch operation.

void AddRange(IReadOnlyList<TElementContainer> newContainers)

Parameters

newContainers IReadOnlyList<TElementContainer>

Clear()

Removes all containers from the collection. Regular children remain untouched.

void Clear()

Insert(int, TElementContainer)

Inserts a container at the specified index.

void Insert(int index, TElementContainer container)

Parameters

index int

container TElementContainer

InsertRange(int, IReadOnlyList<TElementContainer>)

Inserts a range of containers starting at the given index.

void InsertRange(int index, IReadOnlyList<TElementContainer> newContainers)

Parameters

index int

newContainers IReadOnlyList<TElementContainer>

Remove(Func<TElementContainer, bool>)

Removes the first container matching the predicate.

bool Remove(Func<TElementContainer, bool> predicate)

Parameters

predicate Func<TElementContainer, bool>

Returns

bool

Remove(TElementContainer)

Removes a specific container if it belongs to this collection.

bool Remove(TElementContainer collectionElement)

Parameters

collectionElement TElementContainer

Returns

bool

RemoveAt(int)

Removes the container at the specified index.

bool RemoveAt(int index)

Parameters

index int

Returns

bool

RemoveRange(int, int)

Removes a range of containers. Does not affect regular (non-collection) children.

void RemoveRange(int index, int count)

Parameters

index int

count int