RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
replace_navigation

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
replace_navigation [2017/06/11 12:57] – justinreplace_navigation [2021/04/21 18:42] (current) – justin
Line 2: Line 2:
 ---- ----
  
-Replaces one navigation 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. +
-  * **//NONE://** Characters cannot walk or interact between the tiles.+
  
 +====Signature:====
 <code python> <code python>
 replace_navigation(entity, navigation_type, new_navigation_type) replace_navigation(entity, navigation_type, new_navigation_type)
Line 14: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|entity|Tile or object to replace navigation to/from.|[[Entity]]|Yes| +|entity|Entity to replace navigation to/from.|[[Entity]], [[groups|Group]]|Yes| 
-|navigation_type|Existing navigation type that will be replaced.|[[Constant]]|Yes| +|navigation_type|Existing navigation type that will be replaced.|[[navigation_and_interaction|Navigation Type]]|Yes| 
-|new_navigation_type|New navigation type to replace the existing type with.|[[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%> <WRAP center round info 100%>
-See [[Modify Navigation]] if you'd like to only change the navigation type between two specific tiles instead of any tiles relative to an entity.+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> </WRAP>
  
 ====Example:==== ====Example:====
-<code lua> +<code bauxite> 
-replace_navigation(self, INTERACT_ONLY, WALK_AND_INTERACT)+replace_navigation(self, INTERACT_ONLY, WALK_AND_INTERACT);
 </code> </code>
-//Results:// Any navigation paths in each of the four cardinal directions from the entity that this script is attached to that currently have a type of INTERACT_ONLY will be changed to WALK_AND_INTERACT (now allowing characters to pass through).+//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%> <WRAP center round tip 100%>
-Use the **Replace Navigation** function to easily update the navigation for any tiles surrounding an obstacle that has been removed or a door that has been opened to enable characters to pass through.+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> </WRAP>
  
replace_navigation.1497211031.txt.gz · Last modified: 2017/06/11 12:57 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki