Stratagus Configuration Language Description: Map Presentation

         _________ __                 __                               
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \ 
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/ 
    ______________________                           ______________________
			  T H E   W A R   B E G I N S
	   Stratagus - A free fantasy real time strategy game engine

(C) Copyright 1998-2006 by The Stratagus Project. Distributed under the "GNU General Public License"

Intro - Introduction to functions to present maps

• First the presentation step which tells what the map will be alike. The presentation step is used before starting a game and allows the player to select the map he wants.

• The setup step builds the map when starting a game. At that stage the needed tilesets and the whole map are loaded into the engine.

This page documents map presentation functions.

PresentMap(description, numplayers, mapwidth, mapheight, mapuid)

description

A textual description of the map that can be displayed to the user.

numplayers

The maximum number of players for this map.

mapwidth and mapheight

The sizes of the map.

mapuid

Random number to distinguish maps with the same file name. Be sure to change this number when changing the map.

Example

    PresentMap("Doom World", 4, 64, 64)

SetMapMiniImage(mapimage)

mapimage

Path to the file with the graphic.

Note: This is for the new map format. Not implemented yet.

Example

    SetMiniImage("doomworld/doomworld.png")

DefinePlayerType(player1, player2, ...)

• "neutral"
• "nobody"
• "computer"
• "person"
• "rescue-passive"
• "rescue-active"

Example

    DefinePlayerTypes("person", "person")

DefineMapSetup(luafile)

Example

    DefineMapSetup("doomworld/doomworld.map")

GetMapOption(name)

A map can define configuration options. A player can modify those options just before starting a game. For example: the tileset to use, your race, game type, number of opponents or the amount of resources on the map.

Note: This is for the new map format. Not implemented yet.

Example

    tileset = GetMapOption("tileset")

DefineMapOption(name, {possible-values})

name

Name of the option.

possible-values

List of values the player can select. The first value is the default value.

Note: This is for the new map format. Not implemented yet.

Example

   DefineMapOption("Resources", {"Map default", "Low", "Medium", "High"})
   DefineMapOption("Difficulty", {"finger in the nose", "easy", "mission impossible"})
   DefineMapOption("TileSet", {"desert", "winter", "forest"})