RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
request_coordinate

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
request_coordinate [2022/03/14 21:33] – justinrequest_coordinate [2022/03/14 21:39] – justin
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|start_z|Initial Z coordinate of the selection cursor.|[[Number]]|Yes| +|start_z|Initial Z [[coordinate]] of the selection cursor.|[[Number]]|Yes| 
-|min_z|Minimum Z coordinate allowed.|[[Number]]|Yes| +|min_z|Minimum Z [[coordinate]] allowed.|[[Number]]|Yes| 
-|max_z|Maximum Z coordinate allowed.|[[Number]]|Yes| +|max_z|Maximum Z [[coordinate]] allowed.|[[Number]]|Yes| 
-|step_z|Amount to change the Z coordinate by when adjusting up/down.|[[Number]]|Yes|+|step_z|Amount to change the Z [[coordinate]] by when adjusting up/down.|[[Number]]|Yes|
 |validation_func|Name of custom function that is called to validate the [[coordinate]] at the current cursor location. If supplied, this function should have one input argument, into which the current [[coordinate]] will be passed.|[[String]]|No| |validation_func|Name of custom function that is called to validate the [[coordinate]] at the current cursor location. If supplied, this function should have one input argument, into which the current [[coordinate]] will be passed.|[[String]]|No|
  
Line 28: Line 28:
 </code> </code>
 //Results:// //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 (in this case, there isn't an existing [[tile]] at that location and the [[coordinate]] is one of three allowed locations in the [[array]] named "valid_coords"). Once the player selects a valid [[coordinate]], it will be stored into the $result variable.+Prompts the player for a [[tile]] [[coordinate]], with a starting Z value of zero, a minimum Z value of -64, a maximum Z value of 64, and increments of 16. The custom "validate_coord" function is called to check if the [[coordinate]] at the current cursor location is valid (in this case, it's ensuring that there isn't an existing [[tile]] at that location and that the [[coordinate]] is one of three allowed locations in the $valid_coords [[array]] variable). Once the player selects a valid [[coordinate]], it will be stored into the $result variable.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
request_coordinate.txt · Last modified: 2022/03/14 21:43 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki