ScarDoc

Start typing to search the SCAR reference.

Function
HintPoint

HintPoint_Add

Creates a hintpoint attached to a Marker, EGroup, SGroup or position

On this page
HintPoint_Add(where, bVisible, hintText, height, actionType, iconName, priority, visibleInFOW, dataTemplate)

Description

If range is set to 0, then the hintpoint is rangeless, see the design document for rangeless features. The following types of hintpoint actions are available. HPAT_Objective HPAT_Hint HPAT_Critical HPAT_Movement HPAT_Attack HPAT_FormationSetup HPAT_RallyPoint HPAT_DeepSnow HPAT_CoverGreen HPAT_CoverYellow HPAT_CoverRed HPAT_Detonation HPAT_Vaulting

Parameters

  • whereStackVarrequired
  • bVisibleBooleanrequired
  • hintTextLocStringrequired
  • heightRealoptional
  • actionTypeHintPointActionTypeoptional
  • iconNameStringoptional
  • priorityRealoptional
  • visibleInFOWBooleanoptional
  • dataTemplateStringoptional

Returns

HintPointID

Source

Declared in the game's script sources at:

scar/ui.scar