MapLayer Interface Reference

Public Member Functions
proto external int	Index ()
	This layer index.
proto external void	SetFactionSize (int size)
proto external MapDescriptorProps	GetPropsFor (int iFaction, EMapDescriptorType type)
	Get descriptor properties for certain type.
proto external MapGridProps	GetGridProps ()
	Returns grid properties of the map layer.
proto external MapLegendProps	GetLegendProps ()
	Returns legend properties of the map layer.
proto external MapContourProps	GetContourProps ()
	Returns contour properties of the map layer.
proto external MapLinkProps	GetMapLinkProps ()
	Returns link properties of the map layer.
proto external MapSelectionProperties	GetSelectionProps ()
	Returns map selection properties of the layer.
proto external MapRoadProps	GetRoadProps ()
	Returns roads/ paths properties of the layer.
proto external MapPowerLineProps	GetPowerLineProps ()
	Returns powerlines properties of the layer.
proto external MapBuildingProps	GetBuildingProps ()
	Returns building properties of the layer.
proto external MapWaterBodyProps	GetWaterBodyProps ()
	Returns water body properties of the layer.
proto external MapHillProps	GetHillProps ()
	Returns hill properties of the layer.
proto external MapAreaProperties	GetAreaProps ()
proto external MapDrawingProps	GetMapDrawingProps ()
	Returns drawing properties of the map layer.
proto void	SetAll (const EMapDescriptorType eType, const int iFactionIndex, const int _fcolor, const int _bcolor, const int _ocolor, const int _tcolor, const float _selfscale, const float _textscale, const float selfScaleMin=0.25, const float selfScaleMax=4, const float textScaleMin=8, const float textScaleMax=40, vector offset=vector.Zero, ResourceName font="")
	Sets giving information to the giving descriptor type of the given faction.
proto external void	ModifyFaction (int iFactionIndex, int uColor)
	Sets giving color to the whole colorized descriptors of the given faction.
proto external void	SetCeiling (float limit)
proto external float	GetCeiling ()

Member Function Documentation

GetAreaProps()

proto external MapAreaProperties MapLayer.GetAreaProps

(

)

GetBuildingProps()

proto external MapBuildingProps MapLayer.GetBuildingProps

(

)

Returns building properties of the layer.

GetCeiling()

proto external float MapLayer.GetCeiling

(

)

GetContourProps()

proto external MapContourProps MapLayer.GetContourProps

(

)

Returns contour properties of the map layer.

GetGridProps()

proto external MapGridProps MapLayer.GetGridProps

(

)

Returns grid properties of the map layer.

GetHillProps()

proto external MapHillProps MapLayer.GetHillProps

(

)

Returns hill properties of the layer.

GetLegendProps()

proto external MapLegendProps MapLayer.GetLegendProps

(

)

Returns legend properties of the map layer.

GetMapDrawingProps()

proto external MapDrawingProps MapLayer.GetMapDrawingProps

(

)

Returns drawing properties of the map layer.

GetMapLinkProps()

proto external MapLinkProps MapLayer.GetMapLinkProps

(

)

Returns link properties of the map layer.

GetPowerLineProps()

proto external MapPowerLineProps MapLayer.GetPowerLineProps

(

)

Returns powerlines properties of the layer.

GetPropsFor()

proto external MapDescriptorProps MapLayer.GetPropsFor	(	int	iFaction,
		EMapDescriptorType	type )

Get descriptor properties for certain type.

Returns null if iFaction is illegal or out of range.

GetRoadProps()

proto external MapRoadProps MapLayer.GetRoadProps

(

)

Returns roads/ paths properties of the layer.

GetSelectionProps()

proto external MapSelectionProperties MapLayer.GetSelectionProps

(

)

Returns map selection properties of the layer.

GetWaterBodyProps()

proto external MapWaterBodyProps MapLayer.GetWaterBodyProps

(

)

Returns water body properties of the layer.

Index()

proto external int MapLayer.Index

(

)

This layer index.

ModifyFaction()

proto external void MapLayer.ModifyFaction	(	int	iFactionIndex,
		int	uColor )

Sets giving color to the whole colorized descriptors of the given faction.

SetAll()

proto void MapLayer.SetAll	(	const EMapDescriptorType	eType,
		const int	iFactionIndex,
		const int	_fcolor,
		const int	_bcolor,
		const int	_ocolor,
		const int	_tcolor,
		const float	_selfscale,
		const float	_textscale,
		const float	selfScaleMin = 0.25,
		const float	selfScaleMax = 4,
		const float	textScaleMin = 8,
		const float	textScaleMax = 40,
		vector	offset = vector.Zero,
		ResourceName	font = "" )

Sets giving information to the giving descriptor type of the given faction.

FACTION_ALL (-1) sets for the whole factions.

SetCeiling()

proto external void MapLayer.SetCeiling

(

float

limit

)

SetFactionSize()

proto external void MapLayer.SetFactionSize

(

int

size

)

---

The documentation for this interface was generated from the following file:

• Game/generated/Map/MapLayer.c