GearMessages: Update gmDestroy/gmDelete
authorWuzzy
Wed, 16 Jan 2019 22:46:45 +0000
changeset 1705 39af8c72daef
parent 1704 09694f0d4e90
child 1706 5acc46053f37
GearMessages: Update gmDestroy/gmDelete
GearMessages.wiki
--- a/GearMessages.wiki	Tue Jan 15 00:23:57 2019 +0000
+++ b/GearMessages.wiki	Wed Jan 16 22:46:45 2019 +0000
@@ -12,15 +12,15 @@
 || `gmSwitch` || Switch hedgehog || _Not used._ ||
 || `gmLJump` || Long jump || _Not used._ ||
 || `gmHJump` || High jump || _Not used._ ||
-|| `gmDestroy` || Request gear kill itself || _Not used._ ||
 || `gmSlot` || Weapons slot selected. || Used. ||
 || `gmWeapon` || Weapon seleced. || Used. ||
 || `gmTimer` || Timer set. || Used. ||
 || `gmAnimate` || Start animation || Used. ||
 || `gmPrecise` || Precise || _Not used._ ||
+|| `gmDestroy` || Request gear to remove itself. If present, the gear's removal and cleanup routine will be called. || _Not used._ ||
+|| `gmDelete` || Delete gear the “hard” way. The gear removal routine will be skipped. Use with care! || _Not used._ ||
 || `gmRemoveFromList` || Remove from gear list || _Not used._ ||
 || `gmAddToList` || Insert in gear list || _Not used._ ||
-|| `gmDelete` || Delete gear || _Not used._ ||
 || `gmAllStoppable` || Bitwise OR of `gmLeft`, `gmRight`, `gmUp`, `gmDown`, `gmAttack` and `gmPrecise` ||_Not used._ ||
 
 `gmAddToList` and `gmRemoveFromList` are intended for use by the engine when changing order of gears in the list.  It is not recommended that Lua changes these, and at present they are used together when changing a gear's Z (drawing order). For example, if Lua sets `gmRemoveFromList`, it would cause a leak of the gear, since Lua would no longer be able to restore it. Setting both together would have no effect since Lua cannot at present change Z.