Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Remove a game object from the map...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
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

Code Block
themeRDark
languagejavascript
linenumberstrue
removeObject(someObject); // no special effect
 
removeObject(someOtherObject, true); // show it blowing up
Div
classbox
Availability
Status
colourYellow
title3.2+

Requires:

  • Warzone 3.2 or above

Earlier versions:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5