User Tools

Site Tools


request_coordinate

This is an old revision of the document!


Request Coordinate


Prompts the player for a tile coordinate using a 3D selection cursor. The selected coordinate is returned by this function and can be stored into a property or variable for further action. While the selection cursor is active, the player can adjust it up and down using the move forward/backward keys or the up/down arrow keys (based on the range set by the minimum and maximum Z values).

Signature:

request_coordinate(start_z, min_z, max_z, step_z, validation_func)
ArgumentDescriptionTypeRequired
start_zInitial Z coordinate of the selection cursor.NumberYes
min_zMinimum Z coordinate allowed.NumberYes
max_zMaximum Z coordinate allowed.NumberYes
step_zAmount to change the Z coordinate by when adjusting up/down.NumberYes
validation_funcName of custom function that is called to validate the coordinate at the current cursor location. The function should have one input argument, into which the current coordinate will be passed.StringNo

Example:

request_coordinate(0, -64, 64, 16, "validate_coord");

Results: Prompts the player for a tile coordinate, with a starting Z value of zero, a minimum of -64, a maximum of 64, and increments of 16. The custom “validate_coord” function is called to validate whether or not the coordinate at the current cursor location is valid.

Use the Request Coordinate function as a way for the player to dynamically place tiles into the world, for example to build walls, bridges, or even houses!


Editor Node:

Visual Demo:

request_coordinate.1647317885.txt.gz · Last modified: 2022/03/14 21:18 by justin