ds_grid_get_max

Returns the max value from all the cells within a region on a grid.

Syntax:

ds_grid_get_max(index, x1, y1, x2, y2);


Argument Description
index The index of the grid.
x1 The left cell column of the region.
y1 The top cell row of the region.
x2 The right cell column of the region.
y2 The bottom cell row of the region.


Returns: Real or String


Description

This function can be used to find the maximum value for all the cells found within the defined region of a grid, as shown in the image below:


Example:

val = ds_grid_get_max(grid, 0, 0, 5, 5);

The above code will set the variable "val" to the maximum value contained within the given region of the ds_grid indexed in the variable "grid".


Back: DS Grids
Next: ds_grid_get_mean
© Copyright YoYo Games Ltd. 2017 All Rights Reserved