Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_Waypoint Interface Reference
Inheritance diagram for SCR_Waypoint:

Public Member Functions

void ShowDistance (bool show)
 
void EnableFading (bool enable)
 
bool FadingEnabled ()
 
bool IsEnabled ()
 
void SetEnabled (bool enable)
 
void SetOffsetVector (vector offset)
 
Widget GetWidget ()
 Get Waypoint Widget.
 
bool IsVisible ()
 
void SetVisible (bool visible)
 
void SetColor (notnull Color color)
 
void SetIconImage (string imageName, bool visible, int index=0)
 
IEntity GetAttachedEntity ()
 
void AttachToEntity (IEntity entity)
 Attach waypoint to entity, copying its position.
 
void SetPositionStatic (vector pos)
 Set only static position, not attached to entity.
 
vector GetPosition ()
 Get waypoint position. Attached entity is prioritized over static position.
 
void SCR_Waypoint (ResourceName resourceName, Widget rootW)
 
void ~SCR_Waypoint ()
 

Public Attributes

int m_iMinimumDrawDistance
 
int m_iMaximumDrawDistance = -1
 
RichTextWidget m_wTitle
 
RichTextWidget m_wDistance
 
ImageWidget m_wIcon
 

Protected Attributes

string m_sImageSetResourceName = "{6EAF838A9284890D}UI/Imagesets/Tutorial-Waypoints/Tutorial-Waypoints.imageset"
 
IEntity m_AttachedTo
 
Widget m_wWaypointWidget
 
vector m_vWaypointPos
 
vector m_vOffset = vector.Zero
 
bool m_bEnabled = true
 
bool m_bFadingEnabled
 

Static Protected Attributes

static string WIDGET_NAME_DISTANCE = "Distance"
 
static string WIDGET_NAME_TITLE = "Title"
 
static string WIDGET_NAME_ICON = "Icon_Extra"
 

Constructor & Destructor Documentation

◆ SCR_Waypoint()

void SCR_Waypoint.SCR_Waypoint ( ResourceName resourceName,
Widget rootW )

◆ ~SCR_Waypoint()

void SCR_Waypoint.~SCR_Waypoint ( )

Member Function Documentation

◆ AttachToEntity()

void SCR_Waypoint.AttachToEntity ( IEntity entity)

Attach waypoint to entity, copying its position.

◆ EnableFading()

void SCR_Waypoint.EnableFading ( bool enable)

◆ FadingEnabled()

bool SCR_Waypoint.FadingEnabled ( )

◆ GetAttachedEntity()

IEntity SCR_Waypoint.GetAttachedEntity ( )

◆ GetPosition()

vector SCR_Waypoint.GetPosition ( )

Get waypoint position. Attached entity is prioritized over static position.

◆ GetWidget()

Widget SCR_Waypoint.GetWidget ( )

Get Waypoint Widget.

◆ IsEnabled()

bool SCR_Waypoint.IsEnabled ( )

◆ IsVisible()

bool SCR_Waypoint.IsVisible ( )

◆ SetColor()

void SCR_Waypoint.SetColor ( notnull Color color)

◆ SetEnabled()

void SCR_Waypoint.SetEnabled ( bool enable)

◆ SetIconImage()

void SCR_Waypoint.SetIconImage ( string imageName,
bool visible,
int index = 0 )

◆ SetOffsetVector()

void SCR_Waypoint.SetOffsetVector ( vector offset)

◆ SetPositionStatic()

void SCR_Waypoint.SetPositionStatic ( vector pos)

Set only static position, not attached to entity.

◆ SetVisible()

void SCR_Waypoint.SetVisible ( bool visible)

◆ ShowDistance()

void SCR_Waypoint.ShowDistance ( bool show)

Member Data Documentation

◆ m_AttachedTo

IEntity SCR_Waypoint.m_AttachedTo
protected

◆ m_bEnabled

bool SCR_Waypoint.m_bEnabled = true
protected

◆ m_bFadingEnabled

bool SCR_Waypoint.m_bFadingEnabled
protected

◆ m_iMaximumDrawDistance

int SCR_Waypoint.m_iMaximumDrawDistance = -1

◆ m_iMinimumDrawDistance

int SCR_Waypoint.m_iMinimumDrawDistance

◆ m_sImageSetResourceName

string SCR_Waypoint.m_sImageSetResourceName = "{6EAF838A9284890D}UI/Imagesets/Tutorial-Waypoints/Tutorial-Waypoints.imageset"
protected

◆ m_vOffset

vector SCR_Waypoint.m_vOffset = vector.Zero
protected

◆ m_vWaypointPos

vector SCR_Waypoint.m_vWaypointPos
protected

◆ m_wDistance

RichTextWidget SCR_Waypoint.m_wDistance

◆ m_wIcon

ImageWidget SCR_Waypoint.m_wIcon

◆ m_wTitle

RichTextWidget SCR_Waypoint.m_wTitle

◆ m_wWaypointWidget

Widget SCR_Waypoint.m_wWaypointWidget
protected

◆ WIDGET_NAME_DISTANCE

string SCR_Waypoint.WIDGET_NAME_DISTANCE = "Distance"
staticprotected

◆ WIDGET_NAME_ICON

string SCR_Waypoint.WIDGET_NAME_ICON = "Icon_Extra"
staticprotected

◆ WIDGET_NAME_TITLE

string SCR_Waypoint.WIDGET_NAME_TITLE = "Title"
staticprotected

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