ds_grid_value_exists

Finds whether a certain value appears in a region of a grid.

Syntax:

ds_grid_value_exists(index, x1, y1, x2, y2, val);


Argument Description
index The index of the grid.
x1 The x position of the left of the region in the grid.
y1 The y position of the top of the region in the grid.
x2 The x position of the right of the region in the grid.
y2 The y position of the bottom of the region in the grid.
val The value to find.


Returns: Boolean


Description

With this function you can check to see if a specific value (real or string) is present within a rectangular area of a given ds_grid. If it is present the function will return true otherwise it will return false.


Example:

if ds_grid_value_exists(grid, 0, 1, 5, 6, val)
   {
   xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val);
   ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val);
   }

The above code checks a ds_grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.


Back: DS Grids
Next: ds_grid_value_disk_exists
© Copyright YoYo Games Ltd. 2018 All Rights Reserved