User Tools

Site Tools


load_map

This is an old revision of the document!


Load Map


Loads the specified map. The player will start on the tile at the specified (X,Y,Z) coordinate. The initial direction of the player is optional. If a direction is not supplied, the player's direction 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.

load_map(map_name, player_coord, player_direction)
ArgumentDescriptionTypeRequired
map_nameName of the map to load.StringYes
player_coordCoordinate of the tile on which to position the player.CoordinateYes
player_directionCardinal direction to face the player towards.ConstantNo

Example:

load_map("Start Map", coord[3, 2, 0], SOUTH)

The map with resource name “Start Map” will be loaded and the player will placed onto the tile at coordinate (3, 2, 0) facing south.

load_map.1491854549.txt.gz · Last modified: 2017/04/10 13:02 by justin