array::get_all_closest()
Returns elements sorted by distance from an origin, optionally capped. BO3's decompiled scripts carry no docs for this one: the description is ours, from its name and use.
Signature
array::get_all_closest(org, &array, excluders = [], max = array.size, maxdist)
Needs #using the script that defines it (scripts/shared/array_shared.gsc).
Parameters
| Name | Details |
|---|---|
| org | |
| array | (passed by reference: &) |
| excluders | default: [] |
| max | default: array.size |
| maxdist |
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 69 times in the decompiled scripts. A few, zombies first:
- scripts/zm/_zm_ai_margwa_elemental.gsc, line 495
a_zombies = array::get_all_closest(pos, var_7843fa64, undefined, undefined, range); - scripts/zm/_zm_ai_monkey.gsc, line 94
zombies = array::get_all_closest(origin, getaispeciesarray(level.zombie_team, "all"), undefined, undefined, level.monkey_zombie_groundhit... - scripts/zm/_zm_ai_napalm.gsc, line 609
zombies_axis = array::get_all_closest(self.origin, getaispeciesarray("axis", "all"), undefined, undefined, level.napalmzombiedamageradius); - scripts/zm/_zm_ai_sonic.gsc, line 987
zombies = array::get_all_closest(center, getaispeciesarray("axis", "all"), undefined, undefined, self.death_scream_range); - scripts/zm/_zm_altbody_beast.gsc, line 1722
zombies = array::get_all_closest(center, getaiteamarray(level.zombie_team), undefined, undefined, shockradius);
More in array::
- array::thread_all()Threads a function on every entity in an array, passing the same arguments.
- array::add()Adds an item to an array (no duplicates unless allowed) and returns the array.
- 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::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).