Skip to content

Get Tile Information

Get Tile Information

Retrieves details about a tile at the specified coordinates, such as its region, collision, height, shape, or tile tag.

Properties

System

Name Explanation Type
Collision Whether to retrieve the collision value of the tile. Toggle
Height Whether to retrieve the height value of the tile. Toggle
Region Whether to retrieve the region value of the tile. Toggle
Result The variable to store the tile information result in. Variable or Value
Shape Whether to retrieve the shape value of the tile. Toggle
Strategy The strategy used to find a tile based on the Y position: Down (at or below), Up (at or above), or Closest (nearest). Tile Location Strategy
Tile Tag Whether to retrieve the tile tag value of the tile. Toggle
X The X coordinate of the tile to inspect. Variable or Value
Y The Y coordinate of the tile to inspect. Variable or Value
Z The Z coordinate of the tile to inspect. Variable or Value

Tile Location Strategy

Name Explanation
Down Finds the nearest tile at or below the current Y position.
Up Finds the nearest tile at or above the current Y position.
Closest Finds the nearest tile in either direction from the current Y position.

Examples

Get Tile Collision at Position (5, 0, 5)

This retrieves the collision value of the tile at coordinates (5, 0, 5) using the closest layer, and stores the result in Global Variable 0.

$gv[0] = get_tile_info(5, 0, 5, collision, closest);

{"Data":{"IsCollision":true,"IsHeight":false,"IsRegion":false,"IsShape":false,"IsTileTag":false,"LocationStrategy":2,"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapTileGetDetailsCommand"}

Get Tile Height at Variable Position, Looking Down

This retrieves the height of the tile at coordinates from Global Variables 0 through 2, searching downward, and stores the result in Global Variable 3.

$gv[3] = get_tile_info($gv[0], $gv[1], $gv[2], height, down);

{"Data":{"IsCollision":false,"IsHeight":true,"IsRegion":false,"IsShape":false,"IsTileTag":false,"LocationStrategy":0,"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":3,"Metadata":null},"X":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"Z":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":2,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapTileGetDetailsCommand"}