array::add()
Adds an item to an array (no duplicates unless allowed) and returns the array. BO3's decompiled scripts carry no docs for this one: the description is ours, from its name and use.
Signature
array::add(&array, item, allow_dupes = 1)
Needs #using the script that defines it (scripts/shared/array_shared.gsc).
Parameters
| Name | Details |
|---|---|
| array | (passed by reference: &) |
| item | |
| allow_dupes | default: 1 |
The decompiled scripts don't keep default values, so some of these may be optional: check the real uses below.
Real uses in BO3's scripts
Called 545 times in the decompiled scripts. A few, zombies first:
- scripts/zm/_electroball_grenade.csc, line 171
array::add(level.a_electroball_grenades, self); - scripts/zm/_electroball_grenade.gsc, line 514
array::add(level.a_electroball_grenades, self); - scripts/zm/_zm.csc, line 1519
array::add(self._zombie_visionset_list, temp_struct, 0); - scripts/zm/_zm_ai_napalm.csc, line 198
array::add(self.var_61c885f9, var_b73afa37, 0); - scripts/zm/_zm_ai_wasp.gsc, line 1335
array::add(level.a_wasp_priority_targets, optional_player_target);
More in array::
- array::thread_all()Threads a function on every entity in an array, passing the same arguments.
- array::random()Returns a random element of an array.
- array::randomize()Returns the array in a random order (shuffled).
- array::run_all()Calls a function on every entity in an array (no thread).
- array::filter()Returns the elements of an array that a filter function keeps.
- array::get_all_closest()Returns elements sorted by distance from an origin, optionally capped.
- array::remove_dead()Removes dead entities from an array.
- array::remove_undefined()Removes undefined entries from an array.
- array::contains()True if the array contains a value.
- array::exclude()Returns the array without the items in a second array (or one item).
- array::remove_index()Removes the element at an index and returns the array.
- array::delete_all()Deletes every entity in 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).