SCR_ArrayHelperRefT< Class T > Interface Template Reference

REFERENCE version. More...

Static Public Member Functions
static bool	AreEqual (notnull array< ref T > array1, notnull array< ref T > array2)
	Check if two arrays are equal - shallow check, only class references are verified (not same class/same value)
static void	CopyReferencesFromTo (notnull array< ref T > source, notnull array< ref T > destination)
	Same as array.Copy, but for reference arrays.
static array< ref T >	GetCopy (array< ref T > source)
static void	Intersect (notnull array< ref T > array1, notnull array< ref T > array2, notnull out array< ref T > result)
	Gets all items that are common to the two arrays.
static void	RemoveDuplicates (notnull inout array< ref T > items)
	Remove duplicates from the array by the righthand side (e.g { "a", "b", "a" } -> { "a", "b" }, not { "b", "a" }.
static void	Reverse (notnull inout array< ref T > items)
	Reverse item orders OBSOLETE when array.Reverse appears.
static void	ShuffleRef (notnull inout array< ref T > items, int shuffles=1)
	Shuffle an array of references.

Detailed Description

REFERENCE version.

Member Function Documentation

AreEqual()

static bool SCR_ArrayHelperRefT< Class T >.AreEqual ( notnull array< ref T > array1, notnull array< ref T > array2 )

static

Check if two arrays are equal - shallow check, only class references are verified (not same class/same value)

Parameters

[in]	array1
[in]	array2

Returns

true if equal, false if not

CopyReferencesFromTo()

static void SCR_ArrayHelperRefT< Class T >.CopyReferencesFromTo ( notnull array< ref T > source, notnull array< ref T > destination )

static

Same as array.Copy, but for reference arrays.

See also

GetCopy

Parameters

[in]	source
[in]	destination

GetCopy()

static array< ref T > SCR_ArrayHelperRefT< Class T >.GetCopy ( array< ref T > source )

static

Parameters

[in]

source

Returns

a copy of values or null if source is null

Intersect()

static void SCR_ArrayHelperRefT< Class T >.Intersect ( notnull array< ref T > array1, notnull array< ref T > array2, notnull out array< ref T > result )

static

Gets all items that are common to the two arrays.

Parameters

[in]	array1
[in]	array2
[out]	result

RemoveDuplicates()

static void SCR_ArrayHelperRefT< Class T >.RemoveDuplicates ( notnull inout array< ref T > items )

static

Remove duplicates from the array by the righthand side (e.g { "a", "b", "a" } -> { "a", "b" }, not { "b", "a" }.

Parameters

[in,out]

items

Reverse()

static void SCR_ArrayHelperRefT< Class T >.Reverse ( notnull inout array< ref T > items )

static

Reverse item orders OBSOLETE when array.Reverse appears.

array<int> values = { 2, 42, 33, 0 };
SCR_ArrayHelperT<int>.Reverse(values);
Print(values); // outputs { 0, 33, 42, 2 }

Parameters

[in,out]

items

ShuffleRef()

static void SCR_ArrayHelperRefT< Class T >.ShuffleRef ( notnull inout array< ref T > items, int shuffles = 1 )

static

Shuffle an array of references.

array<ref MyClass> values = { new MyClass(1), new MyClass(2), new MyClass(3), new MyClass(4), new MyClass(5) };
SCR_ArrayHelperT<MyClass>.Shuffle(values);
Print(values); // outputs e.g { MyClass(4), MyClass(1), MyClass(5), MyClass(2), MyClass(3) }

Parameters

[in,out]	items
[in]	shuffles	number of shuffle passes to happen. min 1, max 10

---

The documentation for this interface was generated from the following file:

• Game/Helpers/SCR_ArrayHelper.c