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 |
|---|---|---|
| <Int32Array> | Int32Array | Constructs a new object with the specified count and value. |
| int32 | Add | Adds a value to the end of the array. |
| int32 | AddHexFromString | Creates a hexadecimal value from an accelerator string such as CTRL + A. |
| int32 | Ascending | Insertion sorts values added to this array. |
| int32 | BinarySearch | Performs a binary search across the entire array. |
| int32 | BinarySearchIn | Performs a binary search in a sub-region of the array. |
| int32 | BindIterators | Binds iterators to this object. |
| int32 | BindPointer | Binds a <MemoryPointer> or subclass to this object. The <MemoryPointer> becomes a pointer to this object that can be passed to compatible functions. |
| int32 | Clear | This resets the array count to zero and frees all memory. |
| int32 | Combine | Given ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA. |
| int32 | ConvertBytesToCount | Sets the array count to a value guaranteed to be large enough to store an array of N values. Will round up to the nearest positive <int32> if the byte count provided does not align with the number of bytes per element. For example, ints are 4 bytes each, so providing a value of 16 bytes ensures the array count is set to 4. |
| int32 | Copy | Copies the value of the source array to this array. |
| int32 | DecrementAt | Decrements the value at the specified index. |
| int32 | Del | Removes an item from the array at the specified index. |
| int32 | Descending | Insertion sorts values added to this array. |
| uint64 | Factorial | Returns the value of the array values multiplied against each other. For example: 1, 2, 3, 5 = 1 * 2 * 3 * 5 = 30. |
| int32 | Fill | Fills the array with a single value. |
| int32 | Find | Returns the index of value in the array or -1 if the value cannot be found. |
| int32 | FindAny | Returns true if any of the values in the source array match any of the values in this array. |
| <Int32Iterator> | First | Returns an iterator positioned at the start of the collection. |
| int32 | Get | Returns the value at the specified index. |
| int32 | GetCount | Returns the count of the underlying array object. |
| int32 | GetElementSize | Returns the size in bytes of the primitive type of the array. For example: 4 is 4 bytes for int32, uint32, and <float32>. |
| int32 | GetFirst | Returns the first value in the array. |
| int32 | GetLast | Returns the last value in the array. |
| <Int32Pointer> | GetPointer | Returns a pointer to this object. The pointer object is allocated with new so you must use auto in the declaration or you must manually delete the pointer object. For example: auto Int32Pointer ptr = object.GetPointer(). |
| int32 | GetSizeInBytes | Returns the size in bytes of the array, which is the total number of bytes currently being used by the array, and does not include any allocated reserve. |
| <Int32ArrayView> | GetView | Returns an <Int32ArrayView> that contains first and last iterators for the collection. |
| int32 | In | Returns true if the array contains the specified value. |
| int32 | IncrementAt | Increments the value at the specified index. |
| int32 | Insert | Inserts a value into the array. May incur re-allocation costs depending on the size of any allocated reserve. |
| int32 | IsEmpty | Returns true if the array count is zero. |
| <Int32Iterator> | Last | Returns an iterator positioned at the end of the collection. |
| int32 | Merge | Adds a value to the end if the value is not already in the array. |
| int32 | MoveTo | Relocates a chunk of the array to a new index. |
| int32 | Pop | Pops the first item off the top of the stack. |
| int32 | Print1D | Prints the array in 1D into a <StrList> object. |
| int32 | Print2D | Deprecated |
| uint64 | Product | Computes the product of all the elements in the array. |
| int32 | Push | Pushes an item onto the stack ( at the end ). |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| int32 | RemoveFirst | Removes the first item from the array. Internally performs work using a call to memmove. |
| int32 | RemoveLast | Removes the last item from the array. Internally performs work using a call to memmove. |
| int32 | Set | Sets the value of the item at the specified index. |
| int32 | SetCount | Sets the count of the array. |
| int32 | SetView | Internal use only. |
| int32 | Shrink | Shrinks the array to a sub-range. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Int32Array> | Value | Returns the value of this object's underlying array. For example: to assign the value of this object to another array using array_a.Value = array_b.Value. |
| int32 | Count | Gets or sets the number of values in the array. Setting the count to zero frees all the memory owned by the array, but does not destroy the array object. |
| int32[] | 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 | Reserve | Gets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer. |