MapLegendProps Interface Reference

Public Member Functions
proto external int	GetLineWidth ()
proto external void	SetLineWidth (int width)
proto external int	GetSegmentNumber ()
proto external void	SetSegmentNumber (int num)
proto external int	GetTotalSegmentLength ()
proto external void	SetTotalSegmentLength (int length)
proto external int	GetDistanceTextSize ()
proto external void	SetDistanceTextSize (int size)
proto external int	GetUnitTextSize ()
proto external void	SetUnitTextSize (int size)
proto external float	GetOffsetX ()
proto external void	SetOffsetX (float offset)
proto external float	GetOffsetY ()
proto external void	SetOffsetY (float offset)
proto external bool	GetAlignRight ()
	Gets the current alignment flag for the side of the screen (Left or Right)
proto external void	SetAlignRight (bool align)
	Sets the screen side alignment flag (true = Right)
proto external bool	GetAlignTop ()
	Gets the current alignment flag for the side of the screen (Bottom or Top)
proto external void	SetAlignTop (bool align)
	Sets the screen side alignment flag (true = Top)
proto ref Color	GetSegment1Color ()
proto external void	SetSegment1Color (notnull Color color)
proto ref Color	GetSegment2Color ()
proto external void	SetSegment2Color (notnull Color color)
proto ref Color	GetDistanceTextColor ()
proto external void	SetDistanceTextColor (notnull Color color)
proto ref Color	GetUnitTextColor ()
proto external void	SetUnitTextColor (notnull Color color)
proto external void	SetTextBold ()
proto external void	SetTextItalic ()
proto void	SetFont (ResourceName fontPath)

Member Function Documentation

GetAlignRight()

proto external bool MapLegendProps.GetAlignRight

(

)

Gets the current alignment flag for the side of the screen (Left or Right)

GetAlignTop()

proto external bool MapLegendProps.GetAlignTop

(

)

Gets the current alignment flag for the side of the screen (Bottom or Top)

GetDistanceTextColor()

proto ref Color MapLegendProps.GetDistanceTextColor

(

)

GetDistanceTextSize()

proto external int MapLegendProps.GetDistanceTextSize

(

)

GetLineWidth()

proto external int MapLegendProps.GetLineWidth

(

)

GetOffsetX()

proto external float MapLegendProps.GetOffsetX

(

)

GetOffsetY()

proto external float MapLegendProps.GetOffsetY

(

)

GetSegment1Color()

proto ref Color MapLegendProps.GetSegment1Color

(

)

GetSegment2Color()

proto ref Color MapLegendProps.GetSegment2Color

(

)

GetSegmentNumber()

proto external int MapLegendProps.GetSegmentNumber

(

)

GetTotalSegmentLength()

proto external int MapLegendProps.GetTotalSegmentLength

(

)

GetUnitTextColor()

proto ref Color MapLegendProps.GetUnitTextColor

(

)

GetUnitTextSize()

proto external int MapLegendProps.GetUnitTextSize

(

)

SetAlignRight()

proto external void MapLegendProps.SetAlignRight

(

bool

align

)

Sets the screen side alignment flag (true = Right)

SetAlignTop()

proto external void MapLegendProps.SetAlignTop

(

bool

align

)

Sets the screen side alignment flag (true = Top)

SetDistanceTextColor()

proto external void MapLegendProps.SetDistanceTextColor

(

notnull Color

color

)

SetDistanceTextSize()

proto external void MapLegendProps.SetDistanceTextSize

(

int

size

)

SetFont()

proto void MapLegendProps.SetFont

(

ResourceName

fontPath

)

SetLineWidth()

proto external void MapLegendProps.SetLineWidth

(

int

width

)

SetOffsetX()

proto external void MapLegendProps.SetOffsetX

(

float

offset

)

SetOffsetY()

proto external void MapLegendProps.SetOffsetY

(

float

offset

)

SetSegment1Color()

proto external void MapLegendProps.SetSegment1Color

(

notnull Color

color

)

SetSegment2Color()

proto external void MapLegendProps.SetSegment2Color

(

notnull Color

color

)

SetSegmentNumber()

proto external void MapLegendProps.SetSegmentNumber

(

int

num

)

SetTextBold()

proto external void MapLegendProps.SetTextBold

(

)

SetTextItalic()

proto external void MapLegendProps.SetTextItalic

(

)

SetTotalSegmentLength()

proto external void MapLegendProps.SetTotalSegmentLength

(

int

length

)

SetUnitTextColor()

proto external void MapLegendProps.SetUnitTextColor

(

notnull Color

color

)

SetUnitTextSize()

proto external void MapLegendProps.SetUnitTextSize

(

int

size

)

---

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

• Game/generated/Map/MapLegendProps.c