destroy(destroyChildren, destroyTexture)
Destroys the Game Object. This removes it from its parent group, destroys the input, event and animation handlers if present
and nulls its reference to game
, freeing it up for garbage collection.
If this Game Object has the Events component it will also dispatch the onDestroy
event.
You can optionally also destroy the BaseTexture this Game Object is using. Be careful if you've
more than one Game Object sharing the same BaseTexture.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
destroyChildren | boolean | <optional> | true | Should every child of this object have its destroy method called as well? |
destroyTexture | boolean | <optional> | false | Destroy the BaseTexture this Game Object is using? Note that if another Game Object is sharing the same BaseTexture it will invalidate it. |
- Inherited From
- Source code: gameobjects/components/Destroy.js (Line 37)
Please login to continue.