Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:1.50

Description

Description:Return miscellaneous properties for the currently loaded map.
  • configName: String - WRP file name (for example, "ca\desert\intro.wrp").
  • displayName: String - Display name (for example, "Rahmadi").
  • landRange: Number - Total number of land grid cells that determines the terrain size (default: 128).
  • terrainRange: Number - Range of the terrain grid (default: 512).
  • landGrid: Number - Land grid cell size (default: 40).
  • terrainGrid: Number - Terrain grid (default: 10).
  • satSegmentSize: Number - Size of one satellite tile in LGC (default: 12).
  • WRPVersion: Number - WRP file version (default: 44) (V3.6+).
  • minHeight: Number - Minimum terrain map height (V17.2+).
  • maxHeight: Number - Maximum terrain map height (V17.2+).

Dimensions of the map in meters can be retrieved as terrainRange * terrainGrid.

For details on the returned map parameters, see Terrain Parameters in the VBS Developer Reference.

Syntax

Syntax:mapProperties
Parameters:
Return Value:Array - [WRPName, displayName, landRange, terrainRange, landGrid, terrainGrid, satSegmentSize, WRPVersion, minHeight, maxHeight]

Examples

Examples:
_mapInfo = mapProperties; // might return for Rahmadi:
["ca\desert\intro.wrp","Rahmadi",128,512,40,10,12,44,200,300]

Additional Information

See also: worldName
Multiplayer:
Problems:

Notes