ds_grid_value_x

Returns the x position of a value within a region of a grid.

Syntax:

ds_grid_value_x(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: Real


Description

With this function you can get the x coordinate (within the given rectangular grid region) of the value being searched for. Be aware that if the value being searched for does not exists, the function will return 0, so it is a good idea to check if the values exists first with ds_grid_value_exists then run this function (along with the ds_grid_value_y function) to get the exact position within region being searched.


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_y
© Copyright YoYo Games Ltd. 2017 All Rights Reserved