ScarDoc

Start typing to search the SCAR reference.

Function
Objective

Objective_UpdateText

Updates the title and description for the objective. If you only want to set one of them, pass in nil for the other

On this page
Objective_UpdateText(objTable, new_title, new_description, showTitle, immediate)

Description

Use the immediate flag to make this change happen immediately, bypassing the queue that objective updates normally sit in (i.e. you're updating the objective's title in the middle of its PreStart() function!)

Parameters

  • objTableLuaTablerequired
  • new_titleLocStringrequired
  • new_descriptionLocStringrequired
  • showTitleBooleanoptional
  • immediateBooleanoptional

Returns

Void

Source

Declared in the game's script sources at:

scar/objectives.scar