MapEntity Interface Reference

Inheritance diagram for MapEntity:

Public Member Functions
proto external void	UpdateTexts ()
proto external void	AbsorbData ()
	Absorb world data and create precalculated form for visualisation.
proto external vector	Offset ()
	Starting offset of the map.
proto external vector	Size ()
	Terrain dimensions (x, height = maxElevation-minElevation, z)
proto external float	TerrainUnitScale ()
	Terrain unit scale.
proto external void	SetSelection (vector start, vector end)
	Set selection to visualise (from -> to)
proto external void	ResetSelection ()
	Reset selection to visualise (from -> to)
proto external void	SetFrame (vector start, vector end)
	Set frame to visualise (from -> to)
proto external void	ZoomChange (float level)
	Set new zoom.
proto external void	PosChange (float x, float y)
	Set new pos of map.
proto external void	CursorChange (float x, float y)
	Set new pos of cursor.
proto external float	MinElevation ()
	Minimal map elevation.
proto external float	MaxElevation ()
	Maximal map elevation.
proto external float	ElevationAt (vector pos)
	Get elevation at coords.
proto external void	ShowDiag (bool bEnable)
	Show/ Hide diag.
proto external MapItem	CreateCustomMapItem ()
	Create custom representation from script This representation has no entity and you have to support position and orientation yourself (watch MapItem Api)
proto external int	CountOfVisible ()
	Count of visible.
proto external MapItem	GetVisible (int iIndex)
	Visible by index.
proto external int	GetVisibleAll (out notnull array< MapItem > outItems)
	Gets all the visible map entities in the current view.
proto external int	GetInsideRect (out notnull array< MapItem > outItems, vector from, vector to)
	Get entities in rectangle. Flips the screen y-axis before performing its operation.
proto external int	GetInsideCircle (out notnull array< MapItem > outItems, vector origin, float range)
	Get entities in circle. Flips the screen y-axis before performing its operation.
proto external MapItem	GetClose (vector origin, float range)
	Get entities in rectangle. Flips the screen y-axis before performing its operation.
proto external int	GetSelected (out notnull array< MapItem > outItems)
	Get all selected entities.
proto external int	GetByType (out notnull array< MapItem > outItems, int type)
	Get entities by descriptor type.
proto external void	ResetSelected ()
	Reset all entity selection.
proto external void	ResetHovering ()
	Reset all entity hovering tag.
proto external void	ResetHighlighted ()
	Reset all entity highlighted tag.
proto external void	ShowMultiple (int type, bool bEnable)
	Show/ hide multiple items by type (EMapDescriptorType) of item.
proto external void	ShowEditor (bool bEnable)
	Show/ hide editor items.
proto external void	ShowDebug (bool bEnable)
	Show/ hide debug items (camera, map sizes)
proto external void	EnableVisualisation (bool bValue)
	Enable/ Disable visualisation.
proto external void	EnableGrid (bool bValue)
	Enable/ Disable grid visibility.
proto external void	EnableOverlay (bool bValue)
	Enable/ Disable overlay.
proto external void	InitializeLayers (int count, int factionSize=4)
	Clear layer setup + set new layer count.
proto external int	LayerCount ()
	Get layer count.
proto external MapLayer	GetLayer (int index)
	Get layer by Index.
proto external void	SetLayer (int index)
	Set active layer.
proto external int	GetLayerIndex ()
	Returns -1 if no valid index previously set.
proto external void	SetImagesetMapping (notnull array< int > values)
	Sets corresponding multiple imageset indices for MapDescriptors usage.

Protected Member Functions
proto external void	EnableLegend (bool bValue)
	Enable/ Disable legend.

Member Function Documentation

AbsorbData()

proto external void MapEntity.AbsorbData

(

)

Absorb world data and create precalculated form for visualisation.

CountOfVisible()

proto external int MapEntity.CountOfVisible

(

)

Count of visible.

CreateCustomMapItem()

proto external MapItem MapEntity.CreateCustomMapItem

(

)

Create custom representation from script This representation has no entity and you have to support position and orientation yourself (watch MapItem Api)

CursorChange()

proto external void MapEntity.CursorChange	(	float	x,
		float	y )

Set new pos of cursor.

ElevationAt()

proto external float MapEntity.ElevationAt

(

vector

pos

)

Get elevation at coords.

EnableGrid()

proto external void MapEntity.EnableGrid

(

bool

bValue

)

Enable/ Disable grid visibility.

EnableLegend()

proto external void MapEntity.EnableLegend ( bool bValue )

protected

Enable/ Disable legend.

EnableOverlay()

proto external void MapEntity.EnableOverlay

(

bool

bValue

)

Enable/ Disable overlay.

EnableVisualisation()

proto external void MapEntity.EnableVisualisation

(

bool

bValue

)

Enable/ Disable visualisation.

GetByType()

proto external int MapEntity.GetByType	(	out notnull array< MapItem >	outItems,
		int	type )

Get entities by descriptor type.

GetClose()

proto external MapItem MapEntity.GetClose	(	vector	origin,
		float	range )

Get entities in rectangle. Flips the screen y-axis before performing its operation.

GetInsideCircle()

proto external int MapEntity.GetInsideCircle	(	out notnull array< MapItem >	outItems,
		vector	origin,
		float	range )

Get entities in circle. Flips the screen y-axis before performing its operation.

GetInsideRect()

proto external int MapEntity.GetInsideRect	(	out notnull array< MapItem >	outItems,
		vector	from,
		vector	to )

Get entities in rectangle. Flips the screen y-axis before performing its operation.

GetLayer()

proto external MapLayer MapEntity.GetLayer

(

int

index

)

Get layer by Index.

GetLayerIndex()

proto external int MapEntity.GetLayerIndex

(

)

Returns -1 if no valid index previously set.

GetSelected()

proto external int MapEntity.GetSelected

(

out notnull array< MapItem >

outItems

)

Get all selected entities.

GetVisible()

proto external MapItem MapEntity.GetVisible

(

int

iIndex

)

Visible by index.

GetVisibleAll()

proto external int MapEntity.GetVisibleAll

(

out notnull array< MapItem >

outItems

)

Gets all the visible map entities in the current view.

InitializeLayers()

proto external void MapEntity.InitializeLayers	(	int	count,
		int	factionSize = 4 )

Clear layer setup + set new layer count.

LayerCount()

proto external int MapEntity.LayerCount

(

)

Get layer count.

MaxElevation()

proto external float MapEntity.MaxElevation

(

)

Maximal map elevation.

MinElevation()

proto external float MapEntity.MinElevation

(

)

Minimal map elevation.

Offset()

proto external vector MapEntity.Offset

(

)

Starting offset of the map.

PosChange()

proto external void MapEntity.PosChange	(	float	x,
		float	y )

Set new pos of map.

ResetHighlighted()

proto external void MapEntity.ResetHighlighted

(

)

Reset all entity highlighted tag.

ResetHovering()

proto external void MapEntity.ResetHovering

(

)

Reset all entity hovering tag.

ResetSelected()

proto external void MapEntity.ResetSelected

(

)

Reset all entity selection.

ResetSelection()

proto external void MapEntity.ResetSelection

(

)

Reset selection to visualise (from -> to)

SetFrame()

proto external void MapEntity.SetFrame	(	vector	start,
		vector	end )

Set frame to visualise (from -> to)

SetImagesetMapping()

proto external void MapEntity.SetImagesetMapping

(

notnull array< int >

values

)

Sets corresponding multiple imageset indices for MapDescriptors usage.

SetLayer()

proto external void MapEntity.SetLayer

(

int

index

)

Set active layer.

SetSelection()

proto external void MapEntity.SetSelection	(	vector	start,
		vector	end )

Set selection to visualise (from -> to)

ShowDebug()

proto external void MapEntity.ShowDebug

(

bool

bEnable

)

Show/ hide debug items (camera, map sizes)

ShowDiag()

proto external void MapEntity.ShowDiag

(

bool

bEnable

)

Show/ Hide diag.

ShowEditor()

proto external void MapEntity.ShowEditor

(

bool

bEnable

)

Show/ hide editor items.

ShowMultiple()

proto external void MapEntity.ShowMultiple	(	int	type,
		bool	bEnable )

Show/ hide multiple items by type (EMapDescriptorType) of item.

Size()

proto external vector MapEntity.Size

(

)

Terrain dimensions (x, height = maxElevation-minElevation, z)

TerrainUnitScale()

proto external float MapEntity.TerrainUnitScale

(

)

Terrain unit scale.

UpdateTexts()

proto external void MapEntity.UpdateTexts

(

)

ZoomChange()

proto external void MapEntity.ZoomChange

(

float

level

)

Set new zoom.

---

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

• Game/generated/Map/MapEntity.c