Function; Objective_SetDescription - HWRM/KarosGraveyard GitHub Wiki
Objective_SetDescription(<objective_ID>, <description>)
Description
Clears and then sets the description of the given objective.
- To append to the existing description instead, use
Objective_AddDescription(orObjective_AddDescriptionw) - There is an associated
Objective_SetDescriptionwfor setting a description to an objective which is a 'wide string'.
Example
local kill_cruiser_objective = Objective_Add("kill-battlecruiser", OT_Primary); -- `kill_cruiser_objective` will be an integer (the objective's ID)
Objective_SetDescription(kill_cruiser_objective, "Eliminate the enemy Battlecruisers in the area.");
The description would be
Eliminate the enemy Battlecruisers in the area.
Arguments
| Param | Type | Description |
|---|---|---|
objective_ID |
number |
The integer ID of the object to add description text to. |
description |
string |
Text to set as the description of the objective. |