Function; Objective_SetDescriptionw - HWRM/KarosGraveyard GitHub Wiki
Objective_SetDescriptionw(<objective_ID>, <description>)
Description
Clears and then sets the description of the given objective to some 'wide character' string value (in Lua, a userdata type).
- To append to the existing description instead, use
Objective_AddDescriptionw(orObjective_AddDescription) - There is an associated
Objective_SetDescriptionfor setting a description to an objective which is a normal Lua string.
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 wchar string, presumably from an API call
Objective_SetDescriptionw(kill_cruiser_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 set as the description of the objective. |