PrepareRoute routine
Sets up a new move script for characters to use.
Syntax
function prepareRoute(route: string; loop: boolean): word;
Description
The prepareRoute routine creates a new move script, according to the parameters passed to route. If true is passed to loop, the script will loop continually; if loop is false, it will only run one time. The routine returns an ID number for the new move script, which can be passed to TRpgCharacter.move. If the route entered is identical to an existing move script, it returns that route's ID number instead of creating a duplicate.
The route string is made up of numbers separated by spaces. Each number represents either a movement command or, in a few specific cases, extra data for the previous movement command. The format is currently based on RPG Maker's somewhat convoluted system, and it is not recommended to attempt to write route strings manually. The system will be simplified in a later version.
Related topics
This help file was created with the free trial version of HelpScribble.