Function; Objective_AddDescriptionw - HWRM/KarosGraveyard GitHub Wiki
Objective_AddDescriptionw(<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_SetDescriptionw
(orObjective_SetDescription
) - There is an associated
Objective_AddDescription
for adding a description to an objective which is normal Lua 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)
-- `wstr_description` is some wide character string, presumably from an API call
Objective_AddDescriptionw(kill_cruisers_objective, wstr_description);
Arguments
Param | Type | Description |
---|---|---|
objective_ID |
number |
The integer ID of the object to add description text to. |
description |
userdata |
A userdata value containing a wide-char string, containing text to add to the existing description of the objective. |