Documentation
Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.9.0
Using Move Route ShortcutsTo use the move route shortcuts added by this plugin, you can enter the text codes into the Script command while setting up your movement routes.
Move Route ShortcutsThis plugin supports the following move route shortcuts:
TURNS
Turn To: X Y
Turns the moving unit to face the x/y coordinates
Turn To: Event X
Turns the moving unit to face event id x
Turn To: Player
Turns the moving unit to face the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts)
Turn Away: X Y
Turns the moving unit to face away from the x/y coordinates
Turn Away: Event X
Turns the moving unit to face away from event id x
Turn Away: Player
Turns the moving unit to face away from the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts)
Turn To PF: X Y
Turns the moving unit to face the x/y coordinates. Uses pathfinding.
Turn To PF: Event X
Turns the moving unit to face event id x. Uses pathfinding.
Turn To PF: Player
Turns the moving unit to face the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts). Uses pathfinding.
Turn Away PF: X Y
Turns the moving unit to face away from the x/y coordinates. Uses pathfinding.
Turn Away PF: Event X
Turns the moving unit to face away from event id x. Uses pathfinding.
Turn Away PF: Player
Turns the moving unit to face away from the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts). Uses pathfinding.
The difference between PF and non-PF is that PF versions will use built in pathfinding. Note that this could mean it turns an unexpected way, for example if the path is not direct or blocked.
STEPS
Step To: X Y
Makes the moving unit move one space toward the x/y coordinates
Step To: Event X
Makes the moving unit move one space toward event id x
Step To: Player
Makes the moving unit move one space toward the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts)
Step Away: X Y
Makes the moving unit move one space away from the x/y coordinates
Step Away: Event X
Makes the moving unit move one space away from event id x
Step Away: Player
Makes the moving unit move one space away from the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts)
Step To PF: X Y
Makes the moving unit move one space toward the x/y coordinates by using pathfinding.
Step To PF: Event X
Makes the moving unit move one space toward event id x by using pathfinding.
Step To PF: Player
Makes the moving unit move one space toward the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts). Uses pathfinding.
Step Away PF: X Y
Makes the moving unit move one space away from the x/y coordinates by using pathfinding.
Step Away PF: Event X
Makes the moving unit move one space away from event id x by using pathfinding.
Step Away PF: Player
Makes the moving unit move one space away from the player (this is also a built in move route command, it is provided here automatically due to the way this plugin parses these shortcuts). Uses pathfinding.
The difference between PF and non-PF is that PF versions will use built in pathfinding. Note that this could mean it steps an unexpected way, for example if the path is not direct or blocked.
TELEPORTS
Teleport: Player
Instantly teleports the moving unit to the player's location
Teleport: Event X
Instantly teleports the moving unit to event id x's location
Teleport: X Y
Instantly teleports the moving unit to the given x and y coordinates
SWAPS
Swap: Player
Swaps the moving unit's location with the player's location
Swap: Event X
Swaps the moving unit's location with event id x's location
JUMPS
Jump: Player
Jumps the moving unit to the player's location
Jump: Event X
Jumps the moving unit to event id x's location
Jump: X Y
Jumps the moving unit to the given x and y coordinates
ANIMATIONS
Animation: id
Displays the animation with the provided id on the moving unit
Animation: id true
Same as above, but mirrors the animation
BALLOONS
Balloon: id
Displays the balloon with the provided id on the moving unit. Ballon ids start at 0.
WAITS
Wait Range: min max
Waits for a random amount of frames between min / max values
Example: Wait Range: 5 10
Will wait for a random amount of frames between 5 and 10 (inclusive)
COMMON EVENTS
Common Event: id
Queues the common event with the given id.
SELF SWITCHES
Note: These only work for events, not the player.
Self Switch: X ON
Sets self switch a/b/c/d to ON
Self Switch: X OFF
Sets self switch a/b/c/d to OFF
Self Switch: X TOGGLE
Toggles the value of self switch a/b/c/d (if ON, will turn OFF, if OFF, will turn ON)
VARIABLES
Variable: X MODE VALUE
Sets variable x to a new value depending on the mode/value.
Valid modes include:
= will set the variable to the given value
+ will add the given value to the variable
- will subtract the given value from the variable
* will multiply the variable by the given value
/ will divide the variable by the given value
% will mod the variable by the given value
Examples of variable shortcuts:
Variable: 10 + 5
Will add 5 to variable id 10
Variable: 2 = 100
Will set variable id 2 to 100
Variable: 100 * 2
Will multiply variable id 100 by 2
SCRIPT
Script: id
Runs the script with the associated id from the plugin parameters. A way to have a larger script box to work with than the tiny 1 line move route script box. NOTE: Your script id should NOT contain spaces or symbols.
Plugin CommandsThis plugin does not use any plugin commands.
Saved GamesThis plugin is fully compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_MoveRouteShortcuts.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.
Known Issues
This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.
Compatibility
This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.