RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Load Map======
----

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.

<code python>
load_map(map_name, player_coord, player_direction)
</code>

^Argument^Description^Type^Required^
|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_direction|Cardinal direction to face the player towards.|[[Cardinal Direction]]|No|

====Example:====
<code python>
load_map("Dungeon", coord[2, -3, 1], EAST)
</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.

<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~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation