I_Array (Interface)

Interface for a static array.

Extends: I_Collection

Properties

_Begin

Type: T_Position

Index of the first element.

_End

Type: T_Position

Index of the last element.

Methods

Contains

Returns: BOOL

Checks if item is contained in array.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find.

Get

Returns: I_Array

Gets item from array at specified location.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item.
`Item`	`ANY`	Variable to store returned item.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get_As_String

Returns: I_Array

Returns item as a string, if type to string conversion is supported.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item.
`sItem`	`REFERENCE TO` `STRING`	Variable to store returned item.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get_Generic

Returns: I_Array

Gets an item from the array in it’s generic form. Use carefully as this contains the pointer of the actual value in the collection. If you wish to use this it is recommeded you create a copy of the returned value using MEMMOVE or MEMCPY

Inputs

Name	Type	Description
`Index`	T_Position	Location of item.

Outputs

Name	Type	Description
`Item`	T_Generic
`bSuccess`	`BOOL`

Get_Type_At

Returns: I_Array

Gets the type of the item at specified location.

Inputs

Name	Type	Description
`Index`	T_Position

Outputs

Name	Type	Description
`Item_Type`	T_Type
`bSuccess`	`BOOL`

Reverse

Returns: I_Array

Reverses the order of items in the array.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Search

Returns: I_Array

Find the location of an item in the array.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find.

Outputs

Name	Type	Description
`Index`	T_Position	Location of item.
`bSuccess`	`BOOL`

Set

Returns: I_Array

Changes the item at the specified location in the array.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item.
`Item`	`ANY`	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Set_Generic

Returns: I_Array

Changes the item at the specified location in the array in it’s generic form.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item.
`Item`	T_Generic	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Swap

Returns: I_Array

Swaps item at index with item at index B.

Inputs

Name	Type	Description
`Index_A, Index_B`	T_Position

Outputs

Name	Type	Description
`bSuccess`	`BOOL`