User Tools

Site Tools


reset_map

Differences

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

Link to this comparison view

Next revision
Previous revision
reset_map [2020/06/01 10:19]
justin created
reset_map [2021/04/21 18:43]
justin
Line 2: Line 2:
 ---- ----
  
-Resets the specified map to its original state.+Resets the specified [[map|map]] to its original state. When resetting the current [[map]], the [[player_character|player character]] will be returned to the [[tile|tile]] they started on when the [[map|map]] was last loaded.
  
 ====Signature:==== ====Signature:====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|map_name|Name of the map to reset.|[[String]]|Yes|+|map_name|Name of the [[map|map]] to reset.|[[string|String]]|Yes|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-reset_map("dungeon")+reset_map("dungeon");
 </code> </code>
-//Results:// The map with resource name "Dungeon" is loaded and the player is placed onto the tile at coordinate (2, -3, 1) facing east.+//Results:// The [[map|map]] with resource name "dungeon" is restored to its original state.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Load Map** function to launch an initial map from your game's [[startup script]] or to link tile in one map to another (for example, stairs leading down into dungeon).+Use the **Reset Map** function to reset dungeon containing a series of enemies to defeat or puzzle to solve when the player leaves without completing the area.
 </WRAP> </WRAP>
  
reset_map.txt ยท Last modified: 2021/04/21 18:43 by justin