Path Finding

[Near Fantastica]

Path Finding
Version: 2
by Jaime 'Near Fantastica' Webster
Not DerVVulfman

and Version: 2 beta
Event Start & Option_Close option Correction
Minor Edit By DerVVulfman

BONUS
Version: 1
The original version at the bottom of the post!

Introduction
"NO MORE CUSTOM MOVEMENTS! This script uses path finding to return the shortest path from the START XY to the END XY then uses the custom movement to move the character(s).  You can chain this path finds together to path link between 2 points or more...

As well an Error message will be displayed if you try to send an event to a place it can not get to. 'Target Is Unreachable for Event ID' " - Near Fantastica

By the poster
I didn't create the script, and as of now the links that Near Fantastica put up are down (and he can't get to them) and his RMXP system is down.  Given that he posted the original (though broken) demo links here, there should be no problem to post the script.

However as I didn't create the script, I cannot offer support.


Demo
Both v1 and the new v2 beta in one set
It's about time...

Script
Path Finding v2

Good as it is, it had an error with the system that started to move 'events' on the map.  Also, a feature added by Fuso (the option_close feature) was 'accidentally' removed in version 2.  These have been remedied in the version below, and I added a new feature to change the estimated pathfinding range (explained in script & demo):

Path Finding v2 beta

Instructions revised and included in the script.
Path Finding v2beta


[spoiler=Constants Add-On]This little addon (to be placed above Pathfinding v2 & v2 beta) will allow you to enter recognizable lines in either the $path_finding.add_command_player or the $path_finding.add_command_event routines.

Like

Code:

$path_finding.add_command_player(PF_DOWN, PF_DOWN, PF_LEFT)

Code:

#==============================================================================
# ** Path Finding v2 beta (Constants Add-On)
#------------------------------------------------------------------------------
#
#  This isn't even a script.  It's a simple addon that creates constants to use
#  in the pathfinding system.   You can now type THESE  in place of the numeric
#  command codes when using either the $path_finding.add_command_player  or the
#  $path_finding.add_command_event  routines.   It should  be posted  above the
#  Pathfinding v2 system to take affect.
#
#==============================================================================

PF_DOWN           =  1  # Move down
PF_LEFT           =  2  # Move Up
PF_RIGHT          =  3  # Move Right
PF_UP             =  4  # Move Up
PF_DN_LEFT        =  5  # Move Lower Left
PF_DN_RIGHT       =  6  # Move Lower Right
PF_UP_LEFT        =  7  # Move Upper Left
PF_UP_RIGHT       =  8  # Move Upper Right
PF_RAND           =  9  # Move at Random
PF_TO_PLAYER      = 10  # Move to Player
PF_FR_PLAYER      = 11  # Move from Player
PF_FOREWARD       = 12  # Move 1-Step Foreward
PF_BACKWARD       = 13  # Move 1-Step Backward
PF_JUMP           = 14  # Jump *
PF_WAIT           = 15  # Set Wait Count *
PF_TURN_DOWN      = 16  # Turn Down
PF_TURN_LEFT      = 17  # Turn Left
PF_TURN_RIGHT     = 18  # Turn Right
PF_TURN_UP        = 19  # Turn Up
PF_TURN_90_RT     = 20  # Turn 90? Right
PF_TURN_90_LF     = 21  # Turn 90? Left
PF_TURN_180       = 22  # Turn 180?
PF_TURN_90_RAND   = 23  # Turn 90? Left or Right (Random)
PF_TURN_RAND      = 24  # Turn at Random
PF_TURN_TO_PLAYER = 25  # Turn to Player
PF_TURN_FR_PLAYER = 26  # Turn from Player

#  * These require additional parameters for use (x/y coordinates, time delay
#    or other values)

Instructions
You need to setup a movement event before you can add a path or commands this is done with the $path_finding.setup_event or $path_finding.setup_player command then you can add a command or a path this is done by $path_finding.add_command or $path_finding.add_paths (or appropriate for players movement) commands. Now you can add as many commands and paths as you want to event by adding more of these.  This is called path linking.  Then when you are ready to start the movement use $path_finding.start_event or $path_finding.start_player.

Now this can be done in 2 places in the events command window or in the custom movement of an event. If you do it in the movement window to start use this
return $path_finding.start_event(index) or the code will not work right.

As well I found out something interesting if you have a repeating movement event using this movement with a defined wait the wait will repeat everytime,  but if you add a normal move event wait it will only operate once.  This can be a good things to add this delay so not all the events start at once yet do not repeat that wait later.

Syntax

Event Pathfinding

$path_finding.setup_event(index, repeat, skippable = false)
index = the index of the event
repeat = set the repeat flag to true and the define movement will repeat false it will not repeat..
skippable = set skippable flag to true and the event will move ever when blocked
NOTE : This is not wanted in must cases that is why its defaulted to false

$path_finding.add_command_event(index, code, parameters = [])
index = the index of the event
code = movement code
parameters = the needed parameters for that movement code

Note : the movement codes can be found in the Game_Character page 2 move_type_custom as well as there needed parameters

$path_finding.start_event(index)
index = the index of the event

$path_finding.add_paths_event(index, trg_x, trg_y)
index = the index of the event
trg_x = target x
trg_y = target y

Player Pathfinding

$path_finding.setup_player(repeat, skippable = false)
repeat = set the repeat flag to true and the define movement will repeat false it will not repeat..
skippable = set skippable flag to true and the event will move ever when blocked
NOTE : This is not wanted in must cases that is why its defaulted to false

$path_finding.add_command_player(code, parameters = [])
code = movement code
parameters = the needed parameters for that movement code

Note : the movement codes can be found in the Game_Character page 2 move_type_custom as well as there needed parameters


$path_finding.start_player

$path_finding.add_paths_player(src_x, src_y, trg_x, trg_y)
src_x = source x
src_y = source y
trg_x = target x
trg_y = target y

Try this...

Create a simple map event, and add a 'script call' into the the map event:

Code:

$path_finding.setup_player
$path_finding.add_paths_player(3,1)
$path_finding.start_player

If this event get's activated (probably by touch/action), then the player will move to tile 3/1 on the map.

Credits and Thanks
"Fuso made the main part of this script all I did was make it work.  Fuso needs as much credit or more then I do for this script." - Near Fantastica

BONUS!
Version 1.0

Introduction
I somehow found an old 'abandoned' site that had this version... prior to any SDK edit!  This is the original!??  And as a bonus, this script doesn't conflict with version 2!

Why do you ask?  This system allows you to move to a map event's space and stop right at the event.  In the version 2 system, attempting to move to a space occupied by a map event results in a 'Cannot move to...' prompt/flag.  This one still moves to the spot.  Good if you plan to make a mouse/pathfinding combo.

Script
Path Finding (The Original)

Instructions
Fairly simple.

1. You use $game_player.find_path(x,y) to move the player to a spot on the map.
   
2. Or you can use self.event.find_path(x,y) to move an event to a spot on the map.
   
3. Finally, you can use self.find_path(x,y) for a movement script call to do the same.