GearMessages.wiki
author Wuzzy
Fri, 17 Nov 2017 06:31:42 +0000
changeset 1136 385636c9e7fa
parent 1109 6c9c95f51638
child 1242 c307fe8fb975
permissions -rw-r--r--
ThemeFiles: Add sounds

#summary List of all gear messages.

This is a list of gear messages. Gear messages are used to e.g. control hedgehogs.

= List of gear messages =

|| *Identifier* || *Meaning* || *Parameter* ||
|| `gmLeft` || Walk left || _Not used._ ||
|| `gmRight` || Walk right || _Not used._ ||
|| `gmUp` || Aim up || _Not used._ ||
|| `gmDown` || Aim down || _Not used._ ||
|| `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._ ||
|| `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 change these, and at present they are used together when changing a gear's Z.  For example, if lua set 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.

See https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas (search for "gear messages") for a current list.