ScarDoc

Start typing to search the SCAR reference.

Function
Objective

Objective_AddUIElements

Adds multiple UI elements on one position.

On this page
Objective_AddUIElements(objTable, pos, ping, hintpointText, worldArrow, objectiveArrowOffset, objectiveArrowFacing, actionType, iconName, template, elementID, pingRadius, reticuleRadius)

Description

pos (the target) can be group/entity/squad/marker. worldArrow adds a 3D arrow which points to the target in the world. hintpointText adds a hint point that appears when the target is moused over. If you're adding an arrow or a hintpoint, the target will be among those potentially pointed to by the 2D HUD arrow. objectiveArrowOffset is an offset applied to the arrow's position (you can specify a height offset or a 3D position offset). pingRadius adds a circular area of that radius to the minimap ping. reticuleRadius adds a circular reticule (ground overlay) of that radius.

Parameters

  • objTableLuaTablerequired
  • posPositionrequired
  • pingBooleanoptional
  • hintpointTextLocStringoptional
  • worldArrowBooleanoptional
  • objectiveArrowOffsetFloat/Positionoptional
  • objectiveArrowFacingEntity/Squad/Positionoptional
  • actionTypeHintPointActionTypeoptional
  • iconNameStringoptional
  • templateStringoptional
  • elementIDStringoptional
  • pingRadiusFloatoptional
  • reticuleRadiusFloatoptional

Returns

ElementID

Source

Declared in the game's script sources at:

scar/objectives.scar