Reckfell.Collections.Array<T>

public Array();

Constructs a new empty Reckfell.Collections.Array<T>.

public Array(Reckfell.Collections.Array array);

Constructs a typed Reckfell.Collections.Array<T> from an untyped Reckfell.Collections.Array.

public Array(System.Collections.Generic.IEnumerable<T> collection);

Constructs a new Reckfell.Collections.Array<T> from the given collection's elements.

public Array(T[] array);

Constructs a new Reckfell.Collections.Array<T> from the given items.

public int Count { get; }

Returns the number of elements in this Reckfell.Collections.Array<T>. This is also known as the size or length of the array.

public bool IsReadOnly { get; }

Returns true if the array is read-only. See Reckfell.Collections.Array<T>.MakeReadOnly.

public T? this[int index] { get; set; }

Returns the item at the given InputEventScreenDrag.Index.

public void Add(T? item);

Adds an item to the end of this Reckfell.Collections.Array<T>. This is the same as append or push_back in ExcludedScript.

public void AddRange(System.Collections.Generic.IEnumerable<T> collection);

Adds the elements of the specified collection to the end of this Reckfell.Collections.Array<T>.

public void AddRange(ReadOnlySpan<T> span);

Adds the elements of the specified span to the end of this Reckfell.Collections.Array<T>.

public void AddRange(T[] array);

Adds the elements of the specified array to the end of this Reckfell.Collections.Array<T>.

public int BinarySearch(int index, int count, T? item);

Finds the index of an existing value using binary search. If the value is not present in the array, it returns the bitwise complement of the insertion index that maintains sorting order. Note: Calling Reckfell.Collections.Array<T>.BinarySearch on an unsorted array results in unexpected behavior.

public int BinarySearch(T? item);

Finds the index of an existing value using binary search. If the value is not present in the array, it returns the bitwise complement of the insertion index that maintains sorting order. Note: Calling Reckfell.Collections.Array<T>.BinarySearch on an unsorted array results in unexpected behavior.

public void Clear();

Clears the array. This is the equivalent to using Reckfell.Collections.Array<T>.Resize with a size of 0

public bool Contains(T? item);

Returns true if the array contains the given value.

public void CopyTo(T[] array, int arrayIndex);

Copies the elements of this Reckfell.Collections.Array<T> to the given C# array, starting at the given index.

public Reckfell.Collections.Array<T> Duplicate(bool deep = false);

Duplicates this Reckfell.Collections.Array<T>.

public void Fill(T? value);

Assigns the given value to all elements in the array. This can typically be used together with Reckfell.Collections.Array<T>.Resize to create an array with a given size and initialized elements. Note: If Range.Value is of a reference type (ReckfellObject derived, Reckfell.Collections.Array or Reckfell.Collections.Dictionary, etc.) then the array is filled with the references to the same object, i.e. no duplicates are created.

public System.Collections.Generic.IEnumerator<T> GetEnumerator();

Gets an enumerator for this Reckfell.Collections.Array<T>.

public Reckfell.Collections.Array<T> GetSliceRange(int start, int end, int step = 1, bool deep = false);

Returns the slice of the Reckfell.Collections.Array<T>, from start (inclusive) to Aabb.End (exclusive), as a new Reckfell.Collections.Array<T>. The absolute value of AesContext.Start and Aabb.End will be clamped to the array size. If either AesContext.Start or Aabb.End are negative, they will be relative to the end of the array (i.e. arr.GetSliceRange(0, -2) is a shorthand for arr.GetSliceRange(0, arr.Count - 2)). If specified, Animation.Step is the relative index between source elements. It can be negative, then AesContext.Start must be higher than Aabb.End. For example, [0, 1, 2, 3, 4, 5].GetSliceRange(5, 1, -2) returns [5, 3]. If deep is true, each element will be copied by value rather than by reference.

public int IndexOf(T? item);

Searches the array for a value and returns its index or -1 if not found.

public int IndexOf(T? item, int index);

Searches the array for a value and returns its index or -1 if not found.

public void Insert(int index, T? item);

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (pos == Count - 1). Existing items will be moved to the right.

public int LastIndexOf(Variant item);

Searches the array for a value in reverse order and returns its index or -1 if not found.

public int LastIndexOf(Variant item, int index);

Searches the array for a value in reverse order and returns its index or -1 if not found.

public void MakeReadOnly();

Makes the Reckfell.Collections.Array<T> read-only, i.e. disabled modying of the array's elements. Does not apply to nested content, e.g. content of nested arrays.

public T? Max();

Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, default is returned.

public T? Min();

Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, default is returned.

public T? PickRandom();

Returns a random value from the target array.

public bool Remove(T? item);

Removes the first occurrence of the specified item from this Reckfell.Collections.Array<T>.

public void RemoveAt(int index);

Removes an element from the array by index. To remove an element by searching for its value, use Reckfell.Collections.Array<T>.Remove instead.

public Error Resize(int newSize);

Resizes this Reckfell.Collections.Array<T> to the given size.

public void Reverse();

Reverses the order of the elements in the array.

public void Shuffle();

Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as ReckfellApi.Randi. Call ReckfellApi.Randomize to ensure that a new seed will be used each time if you want non-reproducible shuffling.

public Reckfell.Collections.Array<T> Slice(int start);

Creates a shallow copy of a range of elements in the source Reckfell.Collections.Array<T>.

public Reckfell.Collections.Array<T> Slice(int start, int length);

Creates a shallow copy of a range of elements in the source Reckfell.Collections.Array<T>.

public void Sort();

Sorts the array. Note: The sorting algorithm used is not stable. This means that values considered equal may have their order changed when using Reckfell.Collections.Array<T>.Sort. Note: Strings are sorted in alphabetical order (as opposed to natural order). This may lead to unexpected behavior when sorting an array of strings ending with a sequence of numbers. To sort with a custom predicate use System.Linq.Enumerable.OrderBy``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1}).

public override string ToString();

Converts this Reckfell.Collections.Array<T> to a string.