Differences

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

--- replace_navigation [2017/06/10 19:17] – justin
+++ replace_navigation [2021/04/21 18:42] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Replaces one navigation/interaction type with another for any navigation paths that are connected to the specified tile or object. The acceptable values for navigation type are described below:
+Replaces one navigation type with another for any navigation paths that are connected to the specified entity. The acceptable values for navigation type are listed and explained on the [[Navigation and Interaction]] page.
-  * **//WALK_AND_INTERACT://** Characters can both walk and interact between the tiles.
-  * **//WALK_ONLY://** Characters can only walk between the tiles (no interaction is allowed).
-  * **//INTERACT_ONLY://** Characters can only interact between the tiles (no walking is allowed).
-  * **//PENDING://** Characters cannot walk or interact between the tiles, but a connection is maintained. (This is in support of some future functionality.)
-  * **//NONE://** Characters cannot walk or interact between the tiles.
+====Signature:====
 <code python>
 replace_navigation(entity, navigation_type, new_navigation_type)
@@ Line 14: / Line 10: @@
 ^Argument^Description^Type^Required^
-|entity|ID of the first tile.|[[Entity]]|Yes|
+|entity|Entity to replace navigation to/from.|[[Entity]], [[groups|Group]]|Yes|
-|navigation_type|ID of the second tile.|[[Constant]]|Yes|
+|navigation_type|Existing navigation type that will be replaced.|[[navigation_and_interaction|Navigation Type]]|Yes|
-|new_navigation_type|Navigation type to set between the two tiles.|[[Constant]]|Yes|
+|new_navigation_type|New navigation type to replace the existing type with.|[[navigation_and_interaction|Navigation Type]]|Yes|
+<WRAP center round info 100%>
+See [[Modify Navigation]] if you'd like to only change the navigation type between two specific [[tile|tiles]] instead of any [[tile|tiles]] relative to an [[entity]].
+</WRAP>
 ====Example:====
-<code python>
+<code bauxite>
-replace_navigation("tile01", PENDING, WALK_AND_INTERACT)
+replace_navigation(self, INTERACT_ONLY, WALK_AND_INTERACT);
 </code>
-//Results:// Characters are now able to walk and interact between the tiles with IDs of "tile01" and "tile02".
+//Results:// Any navigation paths in each of the four [[cardinal direction|cardinal directions]] from the [[entity]] that this [[script]] is attached to currently having a type of INTERACT_ONLY will be changed to WALK_AND_INTERACT (now allowing [[character|characters]] to pass through).
 <WRAP center round tip 100%>
-Use the **Replace Navigation** function to .
+Use the **Replace Navigation** function to easily update the navigation for any [[tile|tiles]] surrounding an obstacle that has been removed or a door that has been opened to enable [[character|characters]] to pass through.
 </WRAP>

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation