removeObject()

(info) Other great resources: Official JS API docs, Scripting Forum

removeObject()

Remove a game object from the map...

 

Syntax

removeObject(obj[, effect]);

Parameters

Paramter

Type

Mandatory

Notes

Game version

Paramter

Type

Mandatory

Notes

Game version

obj

Game object

The object to remove.

3.2

effect

Boolean

Should the destruction effect be played?

  • true – yes, make it explode

  • false – no, just remove it

Default: false

3.2

Return value

?

Notes

This function is useful during Player Initialisation when applying baseType setting.

In Warzone 3.1, use removeStruct() to destroy structure objects or DORDER_DESTRUCT to destroy droids.

Example

removeObject(someObject); // no special effect   removeObject(someOtherObject, true); // show it blowing up