Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.39 KB

array_max.md

File metadata and controls

37 lines (26 loc) · 1.39 KB

Home > Community Toolbox Reference > Array utilities > Number array statistics

array_max

Go to source

Returns the highest number from the array or its subsection. If the array/subsection is empty, 0 is returned.

Arguments
Argument Type Usage Description
array Array<Real> Required The array to get the maximum value of.
offset Real Default: 0 The starting index of the subsection (for a negative offset, it will count from array end).
length Real Default: undefined The length of the subsection (for a negative length, it will count backwards from the offset position).
Returns

Real

Example

The following code finds the highest level in the party:

var _heroes = [
    { name: "Alice", level: 14, gold: 165 },
    { name: "Bob", level: 16, gold: 546 },
    { name: "Charlie", level: 9, gold: 1753 },
    ];
var _levels = array_map(_heroes, function(_hero) { return _hero.level; });
var _max_level = array_max(_levels);
show_debug_message(_max_level);

Update history

  • 23.4.0 - Created a function to find the lowest value in a numbers array.