Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Remove a game object from the map...

 

Syntax

removeObject(obj[, effect]);

Parameters

ParamterTypeMandatoryNotesGame version
objGame object(tick)The object to remove.3.2
effectBoolean(error)

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
Availability 3.2+

Requires:

  • Warzone 3.2 or above

Earlier versions:

Contents

Jump to:

 

  • No labels