About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface IReadOnlyList<T>

Represents a read-only collection of elements that can be accessed by index.

interface IReadOnlyList<T> {
    Item: PropertyGet<number | Int32, JsType<T>>;
    get Count(): number;
    "[iterator]"(): Iterator<JsType<T>>;
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
}

Type Parameters

T

Hierarchy (View Summary)

IInterfaceBase
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
- IReadOnlyList

Index

Properties

Accessors

Methods

[iterator] Cast TryCast

Properties

`Readonly`Item

Item: PropertyGet<number | Int32, JsType<T>>

Gets the element at the specified index in the read-only list.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index in the read-only list.

Accessors

Count

get Count(): number
Gets the number of elements in the collection.

Returns number
The number of elements in the collection.

Inherited from IReadOnlyCollection.Count

Methods

[iterator]

"[iterator]"(): Iterator<JsType<T>>
Returns Iterator<JsType<T>>
Overrides IReadOnlyCollection.[iterator]

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IInterfaceBase.Cast

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IInterfaceBase.TryCast