API Host ScriptArray

ScriptArray

Dynamic array object used for host input/output and JSON-like data.

Namespace: AuroraScript.Runtime.Types. Kind: class.

Back to .NET Host API Reference

Overview

Dynamic array object used for host input/output and JSON-like data.

Quick Reference

A minimal use of ScriptArray.

var values = new ScriptArray();
values.Push(ScriptDatum.FromNumber(42));

var first = values.GetElement(0);
Console.WriteLine(first.Number); // 42

Constructors

ScriptArray()

Creates a ScriptArray instance.

ScriptArray()

Parameters

None.

Returns

A new ScriptArray instance.

ScriptArray(int capacity)

Creates a ScriptArray instance.

ScriptArray(int capacity)

Parameters

Name	Type	Required	Description
capacity	int	Yes	Initial storage capacity.

Returns

A new ScriptArray instance.

ScriptArray(ScriptArray array)

Creates a ScriptArray instance.

ScriptArray(ScriptArray array)

Parameters

Name	Type	Required	Description
array	ScriptArray	Yes	Source array or span copied or enumerated by the new instance.

Returns

A new ScriptArray instance.

ScriptArray(List<ScriptObject> list)

Creates a ScriptArray instance.

ScriptArray(List<ScriptObject> list)

Parameters

Name	Type	Required	Description
list	List<ScriptObject>	Yes	Source object list copied into the array.

Returns

A new ScriptArray instance.

ScriptArray(Span<ScriptDatum> array)

Creates a ScriptArray instance.

ScriptArray(Span<ScriptDatum> array)

Parameters

Name	Type	Required	Description
array	Span<ScriptDatum>	Yes	Source array or span copied or enumerated by the new instance.

Returns

A new ScriptArray instance.

ScriptArray(ScriptDatum[] array)

Creates a ScriptArray instance.

ScriptArray(ScriptDatum[] array)

Parameters

Name	Type	Required	Description
array	ScriptDatum[]	Yes	Source array or span copied or enumerated by the new instance.

Returns

A new ScriptArray instance.

ScriptArray(ScriptObject[] array)

Creates a ScriptArray instance.

ScriptArray(ScriptObject[] array)

Parameters

Name	Type	Required	Description
array	ScriptObject[]	Yes	Source array or span copied or enumerated by the new instance.

Returns

A new ScriptArray instance.

Properties

Length

int Length

Parameters

None.

Returns

Returns int.

Methods

GetElement

ScriptDatum GetElement(int index)

void GetElement(int index, ref ScriptDatum scriptDatum)

• ScriptDatum GetElement(int index)
• void GetElement(int index, ref ScriptDatum scriptDatum)

Parameters

Name	Type	Required	Description
index	int	Yes	Zero-based element index.
scriptDatum	ScriptDatum	Varies	Element value or destination described by the selected signature.

Returns

The value-returning overload returns the selected ScriptDatum; the ref overload writes the selected element to scriptDatum and returns no value.

SetElement

void SetElement(int index, in ScriptDatum datum)

Parameters

Name	Type	Required	Description
index	int	Yes	Zero-based element index.
datum	ScriptDatum	Yes	Element value or destination described by the selected signature.

Returns

None.

Push

void Push(ScriptDatum datum)

Parameters

Name	Type	Required	Description
datum	ScriptDatum	Yes	Element value or destination described by the selected signature.

Returns

None.

Remove

void Remove(int index)

Parameters

Name	Type	Required	Description
index	int	Yes	Zero-based element index.

Returns

None.

Values

Span<ScriptDatum> Values()

Parameters

None.

Returns

Returns Span<ScriptDatum>.

ToDatumArray

ScriptDatum[] ToDatumArray()

Parameters

None.

Returns

Returns ScriptDatum[].

Has

bool Has(in ScriptDatum element)

Parameters

Name	Type	Required	Description
element	ScriptDatum	Yes	The ScriptDatum parameter required by the signature.

Returns

Returns bool.

IndexOf

int IndexOf(in ScriptDatum searchElement, int? fromIndex)

Parameters

Name	Type	Required	Description
searchElement	ScriptDatum	Yes	The ScriptDatum parameter required by the signature.
fromIndex	int?	Yes	The int? parameter required by the signature.

Returns

Returns int.

LastIndexOf

int LastIndexOf(in ScriptDatum searchElement, int? fromIndex)

Parameters

Name	Type	Required	Description
searchElement	ScriptDatum	Yes	The ScriptDatum parameter required by the signature.
fromIndex	int?	Yes	The int? parameter required by the signature.

Returns

Returns int.