Difference between revisions of "Remove - Array"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(added category)
imported>Scrivener07
(Removes elements but does not change the length of array.)
Line 30: Line 30:
; In this case, [1, 2, 3, 4, 5] would become [1, 4, 5]
; In this case, [1, 2, 3, 4, 5] would become [1, 4, 5]
</source>
</source>
== Notes ==
* This function does not reduce '''the length'' of the array.


== See Also ==
== See Also ==

Revision as of 05:49, 1 September 2021

Member of: All Arrays

Removes an item or group of items from the array at the specified position, shrinking it to fit.

Syntax

Function Remove(int aiLocation, int aiCount = 1) native

Parameters

  • aiLocation: The location of the item to remove
  • aiCount: The number of items to remove
    • Default: 1

Return Value

None

Examples

; Remove item 0 from the array
MyStringArray.Remove(0)

; In this case, ["Hello", "world"] would become ["world"]


; Remove 2 items starting at position 1 in the array
MyIntArray.Remove(1, 2)

; In this case, [1, 2, 3, 4, 5] would become [1, 4, 5]

Notes

  • This function does not reduce 'the length of the array.

See Also