Function; Objective_AddDescription - HWRM/KarosGraveyard GitHub Wiki
Objective_AddDescription(<objective_ID>, <description>)
Description
Adds a new line followed by the given description text to the current description of the given objective
.
- To clear the old description and set it fresh, use
Objective_SetDescription
(orObjective_SetDescriptionw
) - There is an associated
Objective_AddDescriptionw
for adding a description to an objective which is a 'wide string'.
⚠️ It is currently untested whether or not you may mix normal and wide char strings in the description text block.
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.");
-- later or something
Objective_AddDescription(kill_cruisers_objective, "Additional enemy re-enforcements have arrived; proceed with caution.");
The final description would be
Eliminate the enemy Battlecruisers in the area.
Additional enemy re-enforcements have arrived; proceed with caution.
Arguments
Param | Type | Description |
---|---|---|
objective_ID |
number |
The integer ID of the object to add description text to. |
description |
string |
Text to add to the existing description of the objective. |