GearMessages.wiki
author Wuzzy
Fri, 19 Apr 2019 16:07:50 +0100
changeset 1831 365c30b4c669
parent 1705 39af8c72daef
child 1908 d141b806356e
permissions -rw-r--r--
LuaGears: Add temporary mistake to test documentation script
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
517
34caff484bbd First draft of a list of gear messages. Hey, it’s better than nothing!
almikes@aol.com
parents:
diff changeset
     1
#summary List of all gear messages.
34caff484bbd First draft of a list of gear messages. Hey, it’s better than nothing!
almikes@aol.com
parents:
diff changeset
     2
739
dbbb70728a29 GearMessages: Add title
Wuzzy
parents: 621
diff changeset
     3
This is a list of gear messages. Gear messages are used to e.g. control hedgehogs.
dbbb70728a29 GearMessages: Add title
Wuzzy
parents: 621
diff changeset
     4
dbbb70728a29 GearMessages: Add title
Wuzzy
parents: 621
diff changeset
     5
= List of gear messages =
517
34caff484bbd First draft of a list of gear messages. Hey, it’s better than nothing!
almikes@aol.com
parents:
diff changeset
     6
618
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
     7
|| *Identifier* || *Meaning* || *Parameter* ||
620
c003b62124b6 Typo fix
Wuzzy
parents: 619
diff changeset
     8
|| `gmLeft` || Walk left || _Not used._ ||
618
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
     9
|| `gmRight` || Walk right || _Not used._ ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    10
|| `gmUp` || Aim up || _Not used._ ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    11
|| `gmDown` || Aim down || _Not used._ ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    12
|| `gmSwitch` || Switch hedgehog || _Not used._ ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    13
|| `gmLJump` || Long jump || _Not used._ ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    14
|| `gmHJump` || High jump || _Not used._ ||
621
ed089d5730e5 Clarification of slots
Wuzzy
parents: 620
diff changeset
    15
|| `gmSlot` || Weapons slot selected. || Used. ||
618
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    16
|| `gmWeapon` || Weapon seleced. || Used. ||
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    17
|| `gmTimer` || Timer set. || Used. ||
1109
6c9c95f51638 remove the annoying ????
nemo
parents: 1099
diff changeset
    18
|| `gmAnimate` || Start animation || Used. ||
618
37175ce322cb Some additions
Wuzzy
parents: 592
diff changeset
    19
|| `gmPrecise` || Precise || _Not used._ ||
1705
39af8c72daef GearMessages: Update gmDestroy/gmDelete
Wuzzy
parents: 1250
diff changeset
    20
|| `gmDestroy` || Request gear to remove itself. If present, the gear's removal and cleanup routine will be called. || _Not used._ ||
39af8c72daef GearMessages: Update gmDestroy/gmDelete
Wuzzy
parents: 1250
diff changeset
    21
|| `gmDelete` || Delete gear the “hard” way. The gear removal routine will be skipped. Use with care! || _Not used._ ||
1109
6c9c95f51638 remove the annoying ????
nemo
parents: 1099
diff changeset
    22
|| `gmRemoveFromList` || Remove from gear list || _Not used._ ||
6c9c95f51638 remove the annoying ????
nemo
parents: 1099
diff changeset
    23
|| `gmAddToList` || Insert in gear list || _Not used._ ||
1250
d8f26186f4e5 GearMessages: add comma
Wuzzy
parents: 1242
diff changeset
    24
|| `gmAllStoppable` || Bitwise OR of `gmLeft`, `gmRight`, `gmUp`, `gmDown`, `gmAttack` and `gmPrecise` ||_Not used._ ||
517
34caff484bbd First draft of a list of gear messages. Hey, it’s better than nothing!
almikes@aol.com
parents:
diff changeset
    25
1242
c307fe8fb975 GearMessages: Improve format and fix typos
Wuzzy
parents: 1109
diff changeset
    26
`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.
1109
6c9c95f51638 remove the annoying ????
nemo
parents: 1099
diff changeset
    27
1099
360ee8a95a1f remove line number
nemo
parents: 798
diff changeset
    28
See https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas (search for "gear messages") for a current list.