MapDescriptorProps Interface Reference

Public Member Functions
proto external void	Activate (bool enable)
	De/Active (local properties)
proto external void	Setup (bool enable)
proto external bool	IsVisible ()
proto external void	SetVisible (bool enable)
proto external bool	IsIconVisible ()
proto external void	SetIconVisible (bool enable)
proto void	SetFont (ResourceName fontPath)
proto external bool	IsTextVisible ()
proto external void	SetTextVisible (bool enable)
proto external void	SetTextOffset (vector offset)
proto external void	SetTextOffsetX (float x)
proto external void	SetTextOffsetY (float y)
proto external void	SetIconTextAlignH (float h)
proto external void	SetIconTextAlignV (float v)
proto external void	SetAlignWithParent (bool b)
proto external void	SetTextBold ()
proto external void	SetTextItalic ()
proto external void	SetIconSize (float size, float minScale, float maxScale)
	Set icon scale.
proto external float	GetIconSize ()
	Get icon scale.
proto external void	SetTextSize (float size, float minScale, float maxScale)
	Set text/ description scale.
proto external float	GetTextSize ()
	Get text/ description scale.
proto external void	SetDetail (int iDetail)
	Set tesselation level detail 1 - 255.
proto external int	GetDetail ()
	Get tesselation level detail.
proto external string	GetImageDef ()
	Get current image def.
proto external void	SetImageDef (string name)
	Set image def.
proto external void	SetTextAngle (float angle)
	Set text angle.
proto external float	GetTextAngle ()
	Get text angle.
proto external void	SetGroupType (int type)
	Set group type.
proto external int	GetGroupType ()
	Get group type.
proto external void	SetGroupScale (float scale)
	Set group scale.
proto external float	GetGroupScale ()
	Get group scale.
proto external void	SetPriority (int priority)
	Set display priority.
proto external float	GetPriority ()
	Get display priority.
proto external void	SetFrontColor (notnull Color color)
	Set Front color.
proto ref Color	GetFrontColor ()
	Get Front color.
proto external void	SetBackgroundColor (notnull Color color)
	Set Background color.
proto ref Color	GetBackgroundColor ()
	Get Background color.
proto external void	SetOutlineColor (notnull Color color)
	Set Outline color.
proto ref Color	GetOutlineColor ()
	Get Outline color.
proto external void	SetTextColor (notnull Color color)
	Set Text color.
proto ref Color	GetTextColor ()
	Get Text color.

Member Function Documentation

Activate()

proto external void MapDescriptorProps.Activate

(

bool

enable

)

De/Active (local properties)

GetBackgroundColor()

proto ref Color MapDescriptorProps.GetBackgroundColor

(

)

Get Background color.

GetDetail()

proto external int MapDescriptorProps.GetDetail

(

)

Get tesselation level detail.

GetFrontColor()

proto ref Color MapDescriptorProps.GetFrontColor

(

)

Get Front color.

GetGroupScale()

proto external float MapDescriptorProps.GetGroupScale

(

)

Get group scale.

GetGroupType()

proto external int MapDescriptorProps.GetGroupType

(

)

Get group type.

GetIconSize()

proto external float MapDescriptorProps.GetIconSize

(

)

Get icon scale.

GetImageDef()

proto external string MapDescriptorProps.GetImageDef

(

)

Get current image def.

GetOutlineColor()

proto ref Color MapDescriptorProps.GetOutlineColor

(

)

Get Outline color.

GetPriority()

proto external float MapDescriptorProps.GetPriority

(

)

Get display priority.

GetTextAngle()

proto external float MapDescriptorProps.GetTextAngle

(

)

Get text angle.

GetTextColor()

proto ref Color MapDescriptorProps.GetTextColor

(

)

Get Text color.

GetTextSize()

proto external float MapDescriptorProps.GetTextSize

(

)

Get text/ description scale.

IsIconVisible()

proto external bool MapDescriptorProps.IsIconVisible

(

)

IsTextVisible()

proto external bool MapDescriptorProps.IsTextVisible

(

)

IsVisible()

proto external bool MapDescriptorProps.IsVisible

(

)

SetAlignWithParent()

proto external void MapDescriptorProps.SetAlignWithParent

(

bool

b

)

SetBackgroundColor()

proto external void MapDescriptorProps.SetBackgroundColor

(

notnull Color

color

)

Set Background color.

SetDetail()

proto external void MapDescriptorProps.SetDetail

(

int

iDetail

)

Set tesselation level detail 1 - 255.

SetFont()

proto void MapDescriptorProps.SetFont

(

ResourceName

fontPath

)

SetFrontColor()

proto external void MapDescriptorProps.SetFrontColor

(

notnull Color

color

)

Set Front color.

SetGroupScale()

proto external void MapDescriptorProps.SetGroupScale

(

float

scale

)

Set group scale.

SetGroupType()

proto external void MapDescriptorProps.SetGroupType

(

int

type

)

Set group type.

SetIconSize()

proto external void MapDescriptorProps.SetIconSize	(	float	size,
		float	minScale,
		float	maxScale
	)

Set icon scale.

SetIconTextAlignH()

proto external void MapDescriptorProps.SetIconTextAlignH

(

float

h

)

SetIconTextAlignV()

proto external void MapDescriptorProps.SetIconTextAlignV

(

float

v

)

SetIconVisible()

proto external void MapDescriptorProps.SetIconVisible

(

bool

enable

)

SetImageDef()

proto external void MapDescriptorProps.SetImageDef

(

string

name

)

Set image def.

SetOutlineColor()

proto external void MapDescriptorProps.SetOutlineColor

(

notnull Color

color

)

Set Outline color.

SetPriority()

proto external void MapDescriptorProps.SetPriority

(

int

priority

)

Set display priority.

SetTextAngle()

proto external void MapDescriptorProps.SetTextAngle

(

float

angle

)

Set text angle.

SetTextBold()

proto external void MapDescriptorProps.SetTextBold

(

)

SetTextColor()

proto external void MapDescriptorProps.SetTextColor

(

notnull Color

color

)

Set Text color.

SetTextItalic()

proto external void MapDescriptorProps.SetTextItalic

(

)

SetTextOffset()

proto external void MapDescriptorProps.SetTextOffset

(

vector

offset

)

SetTextOffsetX()

proto external void MapDescriptorProps.SetTextOffsetX

(

float

x

)

SetTextOffsetY()

proto external void MapDescriptorProps.SetTextOffsetY

(

float

y

)

SetTextSize()

proto external void MapDescriptorProps.SetTextSize	(	float	size,
		float	minScale,
		float	maxScale
	)

Set text/ description scale.

SetTextVisible()

proto external void MapDescriptorProps.SetTextVisible

(

bool

enable

)

Setup()

proto external void MapDescriptorProps.Setup

(

bool

enable

)

SetVisible()

proto external void MapDescriptorProps.SetVisible

(

bool

enable

)

---

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

• Game/generated/Map/MapDescriptorProps.c