Public Member Functions
proto external IEntity	Entity ()
	Get owner entity.

proto external MapDescriptorComponent	Descriptor ()
	Get descriptor component.

proto external void	Recycle ()
	Mark this to be recycled (removed from map forever) Once you call this, when item loose all references it will be auto removed from map.

proto external void	SetVisible (bool enable)
	Enable/ disable visibility in map.

proto external bool	IsVisible ()
	Returns true of visibility set On.

proto external void	SetEditor (bool enable)
	Enable/ disable editor-related flags (Editor's descriptor)

proto external bool	IsEditor ()
	Returns true of descriptor belongs to Editor.

proto external void	SetHovering (bool enable)
	Enable/ disable hover-state in map.

proto external bool	IsHovering ()
	Returns true if hover-state set On.

proto external void	SetHighlighted (bool enable)
	Enable/ disable highlighted-state in map.

proto external bool	IsHighlighted ()
	Returns true if highlighted-state set On.

proto external void	Select (bool enable)
	Enable/ disable selection state in map.

proto external bool	IsSelected ()
	Returns true of selected set On.

proto external void	SetLayerLinkProps (bool enable)
	Marks the map item for using MapLayer's link props.

proto external bool	IsUseLayerLinkProps ()
	Returns true if the map item is marked for using MapLayer's link props.

proto external string	GetDisplayName ()
	Get currently assigned text.

proto external void	SetDisplayName (string name, array< string > params=null)
	Set new text.

proto external MapLink	LinkTo (MapItem item)
	Adds a new link between the caller and item (parameter), returns the link created.

proto external int	GetGroupType ()
	Determine group type (EMapDescriptorGroup) of item.

proto external void	SetGroupType (int type)
	Assign different group type (EMapDescriptorGroup) of item.

proto external int	GetPriority ()
	Retrieve priority of item.

proto external void	SetPriority (int iPriority)
	Assign different priority to item.

proto external void	UnLink (MapItem item)
	Remove link (or all links if pItem==nullptr)

proto external int	GetLinks (out notnull array< MapLink > outItems)
	Get current links.

proto external void	ClearLinks ()
	Clear all links.

proto external string	GetInfoText ()
	Get currently assigned Info text.

proto external void	SetInfoText (string name, array< string > params=null)
	Set new Info text.

proto external string	GetImageDef ()
	Get current image def.

proto external void	SetImageDef (string name)
	Set image def.

proto external float	GetRange ()
	Get range size (radio signal for example)

proto external void	SetRange (float range)
	Set range size (radio signal for example)

proto external void	SetAngle (float angle)
	Set angle.

proto external float	GetAngle ()
	Get current angle.

proto external vector	GetPos ()
	Get current position (script does not support vector2d)

proto external void	SetPos (float x, float z)
	Set new position X, Z.

proto external MapDescriptorProps	GetProps ()

proto external void	SetProps (MapDescriptorProps newProps)
	Updates and setups properties of a specific MapItem.

proto external int	GetBaseType ()
	Determine type (EMapDescriptorType) of item.

proto external void	SetBaseType (int type)
	Assign different type (EMapDescriptorType) of item.

proto external int	GetFactionIndex ()
	Get currently assigned faction index 0 == Neutral 1 == East 2 == West.

proto external void	SetFactionIndex (int iIndex)
	Set new faction index 0 == Neutral 1 == East 2 == West.

Member Function Documentation

◆ ClearLinks()

proto external void MapItem.ClearLinks ( )

Clear all links.

◆ Descriptor()

proto external MapDescriptorComponent MapItem.Descriptor ( )

Get descriptor component.

◆ Entity()

proto external IEntity MapItem.Entity ( )

Get owner entity.

◆ GetAngle()

proto external float MapItem.GetAngle ( )

Get current angle.

◆ GetBaseType()

proto external int MapItem.GetBaseType ( )

Determine type (EMapDescriptorType) of item.

◆ GetDisplayName()

proto external string MapItem.GetDisplayName ( )

Get currently assigned text.

◆ GetFactionIndex()

proto external int MapItem.GetFactionIndex ( )

Get currently assigned faction index 0 == Neutral 1 == East 2 == West.

◆ GetGroupType()

proto external int MapItem.GetGroupType ( )

Determine group type (EMapDescriptorGroup) of item.

◆ GetImageDef()

proto external string MapItem.GetImageDef ( )

Get current image def.

◆ GetInfoText()

proto external string MapItem.GetInfoText ( )

Get currently assigned Info text.

◆ GetLinks()

proto external int MapItem.GetLinks ( out notnull array< MapLink > outItems )

Get current links.

◆ GetPos()

proto external vector MapItem.GetPos ( )

Get current position (script does not support vector2d)

◆ GetPriority()

proto external int MapItem.GetPriority ( )

Retrieve priority of item.

◆ GetProps()

proto external MapDescriptorProps MapItem.GetProps ( )

◆ GetRange()

proto external float MapItem.GetRange ( )

Get range size (radio signal for example)

◆ IsEditor()

proto external bool MapItem.IsEditor ( )

Returns true of descriptor belongs to Editor.

◆ IsHighlighted()

proto external bool MapItem.IsHighlighted ( )

Returns true if highlighted-state set On.

◆ IsHovering()

proto external bool MapItem.IsHovering ( )

Returns true if hover-state set On.

◆ IsSelected()

proto external bool MapItem.IsSelected ( )

Returns true of selected set On.

◆ IsUseLayerLinkProps()

proto external bool MapItem.IsUseLayerLinkProps ( )

Returns true if the map item is marked for using MapLayer's link props.

◆ IsVisible()

proto external bool MapItem.IsVisible ( )

Returns true of visibility set On.

◆ LinkTo()

proto external MapLink MapItem.LinkTo ( MapItem item )

Adds a new link between the caller and item (parameter), returns the link created.

◆ Recycle()

proto external void MapItem.Recycle ( )

Mark this to be recycled (removed from map forever) Once you call this, when item loose all references it will be auto removed from map.

◆ Select()

proto external void MapItem.Select ( bool enable )

Enable/ disable selection state in map.

◆ SetAngle()

proto external void MapItem.SetAngle ( float angle )

Set angle.

◆ SetBaseType()

proto external void MapItem.SetBaseType ( int type )

Assign different type (EMapDescriptorType) of item.

◆ SetDisplayName()

proto external void MapItem.SetDisplayName	(	string	name,
		array< string >	params = `null`
	)

Set new text.

◆ SetEditor()

proto external void MapItem.SetEditor ( bool enable )

Enable/ disable editor-related flags (Editor's descriptor)

◆ SetFactionIndex()

proto external void MapItem.SetFactionIndex ( int iIndex )

Set new faction index 0 == Neutral 1 == East 2 == West.

◆ SetGroupType()

proto external void MapItem.SetGroupType ( int type )

Assign different group type (EMapDescriptorGroup) of item.

◆ SetHighlighted()

proto external void MapItem.SetHighlighted ( bool enable )

Enable/ disable highlighted-state in map.

◆ SetHovering()

proto external void MapItem.SetHovering ( bool enable )

Enable/ disable hover-state in map.

◆ SetImageDef()

proto external void MapItem.SetImageDef ( string name )

Set image def.

◆ SetInfoText()

proto external void MapItem.SetInfoText	(	string	name,
		array< string >	params = `null`
	)

Set new Info text.

◆ SetLayerLinkProps()

proto external void MapItem.SetLayerLinkProps ( bool enable )

Marks the map item for using MapLayer's link props.

◆ SetPos()

proto external void MapItem.SetPos	(	float	x,
		float	z
	)

Set new position X, Z.

◆ SetPriority()

proto external void MapItem.SetPriority ( int iPriority )

Assign different priority to item.

◆ SetProps()

proto external void MapItem.SetProps ( MapDescriptorProps newProps )

Updates and setups properties of a specific MapItem.

◆ SetRange()

proto external void MapItem.SetRange ( float range )

Set range size (radio signal for example)

◆ SetVisible()

proto external void MapItem.SetVisible ( bool enable )

Enable/ disable visibility in map.

◆ UnLink()

proto external void MapItem.UnLink ( MapItem item )

Remove link (or all links if pItem==nullptr)

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

Game/generated/Map/MapItem.c

Public Member Functions