Provides script language access to C++ objects of this type.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | Add | Adds a pointer to a <Type> object to the end of the array. This does not transfer ownership of the underlying memory to the array. |
| int32 | Allocate | Allocates objects as indicated by the count and <TypeInformation>. Adds pointers to these objects to the array. |
| int32 | Clear | Clears the array and frees the underlying memory, but does not destroy the <TypeArray> object. |
| int32 | Combine | Given ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA. |
| int32 | Deallocate | Deletes the objects managed by this array and releases the memory back to the operating system. |
| int32 | DeallocateRange | Delets the the specified number of objects at the specified start position. |
| int32 | Del | Removes an item from the array at the specified index. |
| int32 | Fill | Sets all the items in the <TypeArray> to this value. |
| int32 | Find | Finds a value in the <TypeArray> and returns its index, or -1 if the value is not found. |
| <Type> | Get | Returns a pointer to the <Type> object at the specified index. |
| int32 | GetCount | Returns the count of the underlying array object. |
| int32 | In | Returns true if the <Type> object pointer is resident in the array. Otherwise returns false. |
| int32 | Insert | Inserts a value into the array. May incur re-allocation costs depending on the size of any allocated reserve. |
| int32 | Merge | Adds a value to the end if the value is not already in the <Uint8Array>. |
| int32 | Pop | Pops the first item off the top of the stack. |
| int32 | Push | Pushes an item onto the stack ( at the end ). |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| <Type> | Remove | Removes the object from the array and returns a pointer to the object. Does not destroy the object and the object's memory is not released. |
| int32 | Reserve | Gets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer. |
| <Type> | Set | Sets the value at the specified index. |
| int32 | SetCount | Sets the count of this array. |
| int32 | Shrink | Shrinks the array to a subset of itself. |
| int32 | SizeInBytes | Returns the size in bytes of the <TypeArray>, which is the total number of bytes currently being used by the <TypeArray>, and does not include any allocated reserve. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| Type[] | Objects[ index ] | Gets or sets the value of an element in the array at the specified index. The syntax is array.Objects[ n ], where n is a valid index into the array. |
| int32 | Count | Gets or sets the number of bytes in the <Uint8Array>. Setting the count to zero frees all the memory owned by the <Uint8Array, but does not destroy the <Uint8Array> object. |