I_List (Interface)

Interface for a list.

Extends: I_Collection

Properties

_Begin

Type: T_Position

Index of the first element.

_End

Type: T_Position

Index of the last element.

Methods

Append

Returns: I_List

Adds an item to the end of the list.

Inputs

Name	Type	Description
`Item`	`ANY`	Value to store in list

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Clear

Returns: I_List

Empties/Clears/Deletes every item in the list.

Contains

Returns: BOOL

Checks if item is contained in list.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find in list

Get

Returns: I_List

Gets item from list at specified location without removing it

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_List

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_List

Gets a value from a list 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_List

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`

Insert

Returns: I_List

Adds new item to list at specified location, if index = 0, item will be added at the front, if index = count, item will be added at the back

Inputs

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

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Insert_Generic

Returns: I_List

Adds new item to list at specified location using the generic form. If index = 0, item will be added at the front, if index = count, item will be added at the back

Inputs

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

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Prepend

Returns: I_List

Adds an item at the front of the list.

Inputs

Name	Type	Description
`Item`	`ANY`	Value to store in list

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Remove

Returns: I_List

Removes item from the list.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to remove from in list

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Remove_At

Returns: I_List

Remove item at specified location

Inputs

Name	Type	Description
`Index`	T_Position	Location of item

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Remove_Last

Returns: I_List

Removes item at the back of the list.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Resize

Returns: I_List

Manually resize list. If list becomes smaller, item on higher locations will be deleted.

Inputs

Name	Type	Description
`Size`	T_Capacity	New size of list.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Reverse

Returns: I_List

Reverses the order of items in the list

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Search

Returns: I_List

Find the location of an item in list.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find in list

Outputs

Name	Type	Description
`Index`	T_Position	Location of item in list
`bSuccess`	`BOOL`

Set

Returns: I_List

Changes the item at the specified location in the list.

Inputs

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

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Set_Generic

Returns: I_List

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

Inputs

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

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Swap

Returns: I_List

Swaps item at index A with item at index B.

Inputs

Name	Type	Description
`Index_A, Index_B`	T_Position

Outputs

Name	Type	Description
`bSuccess`	`BOOL`