Interface IReadOnlyTagCollection

Namespace

TMPEffects.Tags.Collections

A readonly collection of TMPEffectTagTuple.

public interface IReadOnlyTagCollection : IReadOnlyCollection<TMPEffectTagTuple>, IEnumerable<TMPEffectTagTuple>, IEnumerable

Inherited Members

IReadOnlyCollection<TMPEffectTagTuple>.Count

IEnumerable<TMPEffectTagTuple>.GetEnumerator()

Properties

TagCount

The amount of TMPEffectTagTuple in this collection.

int TagCount { get; }

Property Value

int

Methods

Contains(TMPEffectTag, TMPEffectTagIndices?)

Whether this collection contains the given tag with the given indices (if supplied).

bool Contains(TMPEffectTag tag, TMPEffectTagIndices? indices = null)

Parameters

tag TMPEffectTag

The tag to check.

indices TMPEffectTagIndices?

The tag indices. If you don't care about the tag's indices, leave as default.

Returns

bool

true if this collection contains the given tag with the given indices (if supplied); otherwise false.

IndicesOf(TMPEffectTag)

Get the associated indices of the given tag.

TMPEffectTagIndices? IndicesOf(TMPEffectTag tag)

Parameters

tag TMPEffectTag

The tag to get the indices of.

Returns

TMPEffectTagIndices?

The indices of the given tag, if the tag is contained in the collection; otherwise null.

TagAt(int, int?)

Get the tag at the given startIndex with the correct order.
If order is left to default, the first tag at startIndex will be returned.

TMPEffectTag TagAt(int startIndex, int? order = null)

Parameters

startIndex int

The start index.

order int?

The order at the start index.

Returns

TMPEffectTag

The tag at the given indices, if it exists; otherwise null.

TagsAt(int)

Get the tags starting at the given startIndex.

IEnumerable<TMPEffectTagTuple> TagsAt(int startIndex)

Parameters

startIndex int

The start index.

Returns

IEnumerable<TMPEffectTagTuple>

All tags starting at the given startIndex.

TagsAt(int, TMPEffectTagTuple[], int)

Get the tags starting at the given startIndex.

int TagsAt(int startIndex, TMPEffectTagTuple[] buffer, int bufferIndex = 0)

Parameters

startIndex int

The start index.

buffer TMPEffectTagTuple[]

The buffer the tags will be stored in.

bufferIndex int

The offset index of the buffer, i.e. the index at which the tags should be inserted into buffer.

Returns

int

The amount of tags starting at the given startIndex.