API Host ScriptEnumerator

ScriptEnumerator

Enumerator returned by ScriptObject and ScriptArray enumeration APIs.

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

Back to .NET Host API Reference

Overview

Enumerator returned by ScriptObject and ScriptArray enumeration APIs.

Quick Reference

A minimal use of ScriptEnumerator.

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

var iterator = values.GetEnumerator();
while (iterator.NextValue(out var item))
{
    Console.WriteLine(item.Number);
}

Constructors

ScriptEnumerator(ScriptArray array)

Creates a ScriptEnumerator instance.

ScriptEnumerator(ScriptArray array)

Parameters

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

Returns

A new ScriptEnumerator instance.

ScriptEnumerator(ScriptDatum[] items)

Creates a ScriptEnumerator instance.

ScriptEnumerator(ScriptDatum[] items)

Parameters

Name	Type	Required	Description
items	ScriptDatum[]	Yes	Items copied into the enumerator.

Returns

A new ScriptEnumerator instance.

ScriptEnumerator(List<ScriptDatum> items)

Creates a ScriptEnumerator instance.

ScriptEnumerator(List<ScriptDatum> items)

Parameters

Name	Type	Required	Description
items	List<ScriptDatum>	Yes	Items copied into the enumerator.

Returns

A new ScriptEnumerator instance.

Methods

FromString

static ScriptEnumerator FromString(string value)

Parameters

Name	Type	Required	Description
value	string	Yes	String whose characters are exposed by the enumerator.

Returns

Returns ScriptEnumerator.

Value

ScriptDatum Value()

Parameters

None.

Returns

Returns ScriptDatum.

NextValue

bool NextValue(out ScriptDatum data)

Parameters

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

Returns

Returns bool.

HasValue

bool HasValue()

Parameters

None.

Returns

Returns bool.

Next

void Next()

Parameters

None.

Returns

None.

Reset

void Reset()

Parameters

None.

Returns

None.