User Tools

Site Tools


load_map

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
load_map [2017/04/10 12:58] justinload_map [2021/04/21 18:32] (current) justin
Line 2: Line 2:
 ---- ----
  
-Loads the specified map. The player will start on the tile at the specified (X,Y,Z) coordinate. The initial direction of the player can optionally be specified. If the player is currently in a map, the screen will fade out and then fade back in once the new map is loaded.+Loads the specified map and places the player onto the tile at the specified (X,Y,Z) coordinate. The initial direction for the player to face towards is optional. If a direction is not supplied, it will remain unchanged (with a default of south if loading a map for the first time). If the player is already in a map, the screen will fade out and then fade back in once the new map is loaded.
  
 +====Signature:====
 <code python> <code python>
 load_map(map_name, player_coord, player_direction) load_map(map_name, player_coord, player_direction)
Line 11: Line 12:
 |map_name|Name of the map to load.|[[String]]|Yes| |map_name|Name of the map to load.|[[String]]|Yes|
 |player_coord|Coordinate of the tile on which to position the player.|[[Coordinate]]|Yes| |player_coord|Coordinate of the tile on which to position the player.|[[Coordinate]]|Yes|
-|player_direction|Cardinal direction to face the player towards.|[[Constant]]|No|+|player_direction|Cardinal direction to face the player towards.|[[Cardinal Direction]]|No|
  
 ====Example:==== ====Example:====
-<code python+<code bauxite
-load_map("Start Map", coord[3, 2, 0], SOUTH)+load_map("Dungeon", coord[2, -3, 1], EAST);
 </code> </code>
-The map with resource name "Start Mapwill be loaded and the player will placed onto the tile at coordinate (3, 2, 0) facing south.+//Results:// The map with resource name "Dungeonis loaded and the player is placed onto the tile at coordinate (2, -3, 1) facing east. 
 + 
 +<WRAP center round tip 100%> 
 +Use the **Load Map** function to launch an initial map from your game's [[startup script]] or to link a tile in one map to another (for example, stairs leading down into a dungeon). 
 +</WRAP> 
 + 
 + 
 +---- 
 + 
 +<WRAP group> 
 +<WRAP half column> 
 +====Editor Node:==== 
 +{{:wiki:load_map_node.png?nolink|}} 
 +</WRAP> 
 + 
 +<WRAP half column> 
 +====Visual Demo:====  
 +{{:wiki:load_map_demo.gif?nolink|}} 
 +</WRAP> 
 +</WRAP> 
 + 
 +~~NOTOC~~ 
load_map.1491854286.txt.gz · Last modified: 2017/04/10 12:58 by justin