eventGroupLoss()

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

eventGroupLoss()

Triggered when a game object leaves a group...

 

Syntax

eventGroupLoss(gameObject, groupID, groupSize)

Parameters

Parameter

Type

Notes

Game Version

Parameter

Type

Notes

Game Version

gameObject

Game object

The object that left the group.

Note that in WZ 3.2+, any type of game object can be added to a group.

3.2

groupID

Number

The ID of the group

3.2

groupSize

Number

The size of the group after the object was removed from the group.

3.2

Notes

An object can be removed from a group in four ways:

  • The object is moved to another group

  • The object gets destroyed

  • The object is transferred to an ally (eg. donateObject())

  • The object is assimilated by Nexus Link

The sequence of events is as shown below:

When an object is transferred or assimilated, the .player property of the object sent to eventGroupLoss() will be the original player, whereas the .player property of the object sent to eventObjectTransfer() will be the new owner.

When droids are assimilated via Nexus Link, eventDestroyed() is also triggered, however this is considered to be a bug as the object hasn't actually been destroyed.