GSC reference › Built-in
GetFirstArrayKey()
Built-in (engine)
Server + client
Utility
Returns the first key of the input array.
Signature
GetFirstArrayKey(<array>)
Parameters
| Name | Required? | Details |
|---|---|---|
| array | Required | Input array |
Returns
Returns the first key of the input array.
Example (from Treyarch's docs)
key = GetFirstArrayKey( array )
Real uses in BO3's scripts
Not called anywhere in BO3's shipped scripts, so check it works in your mode before relying on it.
Related built-ins
- GetArrayKeys()Returns an array consisting of the keys of the input array.
- GetLastArrayKey()Returns the last key of the input array.
- GetNextArrayKey()Returns the next key of the input array, after the specified key.
- GetPrevArrayKey()Returns the prev key of the input array, before the specified key.
- array()Create an array
- IsArray()Checks whether this entity/variable is an array
- ArrayRemoveValue()Remove a value from an array (may affect multiple indexes)
- ArrayCombine()Combine two arrays into and returns one new array
- IsInArray()Searches an array to determine if a given value is present in that array
- ArrayGetClosest()Returns the entity/vector that is closest to the <origin> from the <array>.
- ArrayRemoveIndex()Remove a value from an array at a given index
- ArrayCopy()Returns a copy of an array
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).