| Excerpt |
|---|
Remove a label from the game... |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
removeLabel(label); |
Parameters
| Parameter | Type | Mandatory | Notes | Warzone Version |
|---|---|---|---|---|
| label | String |  | The label will be associated with the objectto remove. | 3.2 |
Return value
| Value | Type | Notes | Warzone Version | |
|---|---|---|---|---|
undefined<number> | Undefined | The function does not return anything if sucessfulNumber | The number of labels that were removed:
If <number> is greater than one, it means that somehow the same label was defined multiple times (most likely in labels.ini), and all <number> occurrences were removed. | 3.2 |
| <error> | Error | An error occurred, most likely invalid parameters. | 3.2 |
Notes
When the label is removed, what happens to the object it was pointing to? It depends on the type of object:
- Game objects – the droid/structure/feature will remainOther objects – the object, which now has nothing linking to it, will be deletedobject will be retained
- Location objects – if the object doesn't have any other labels associated with it, it will be deleted
Remember that labels are shared by all scripts, so if you delete a label that deletes it for all other scripts as well.
Example
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var firstTruck = enumDroid(me, DROID_CONSTRUCT)[0]; addLabel(firstTruck, "my_first_truck");if ( removeLabel("foo") ) { // label(s) removed (+ve numbers are truthy) } else { // label not found (0 is falsey) } |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
| ||||
| Div | ||||
|
| Include Page | ||||
|---|---|---|---|---|
|