item-trigger update: specify inventory mode#49
Merged
lethosor merged 2 commits intoDFHack:masterfrom Mar 27, 2018
AtomicChicken:item-trigger-update
Merged
item-trigger update: specify inventory mode#49lethosor merged 2 commits intoDFHack:masterfrom AtomicChicken:item-trigger-update
lethosor merged 2 commits intoDFHack:masterfrom
AtomicChicken:item-trigger-update
Conversation
Previously, item-trigger's inventory update checks only differentiated between equipping and unequipping items. This means that something like modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip -command [ foo ] would trigger foo both in cases where a cap was being worn, and in cases where it was simply being held in the unit’s hand. With this update, the user will now be able to specify the inventory mode alongside onEquip and onUnequip to allow for greater selectivity. Taking the above example, if we wanted to trigger foo only in cases were a cap was being worn, we could specify this via modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip 2 -command [ foo ] or modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip [ 2 ] -command [ foo ] where ‘2’ is the mode type corresponding to ‘Worn’. Multiple inventory mode can be specified. For example, modtools/item-trigger -itemType RING -onUnequip [ 0 1 2 ] -command [ foo ] would trigger foo when a ring in unequipped in cases were it was being hauled, held or worn. A list of inventory mode values has been included in the -help printout. Specifying mode remains optional, preserving backwards compatibility.
lethosor
reviewed
Mar 27, 2018
modtools/item-trigger.lua
Outdated
| utils.fillTable(command,table) | ||
| processTrigger(command) | ||
| utils.unfillTable(command,table) | ||
| end |
Member
Author
There was a problem hiding this comment.
Huh, now how did that get in there?
lethosor
requested changes
Mar 27, 2018
modtools/item-trigger.lua
Outdated
| -onUnequip | ||
| Optionally, the equipment mode can be specified | ||
| Possible values for mode: | ||
| 0 = Hauled |
Member
There was a problem hiding this comment.
Is this a DF enum? If so, you should use human-readable names instead of making people look up numbers every time they want to want to read/write a command.
Member
There was a problem hiding this comment.
On second glance, it looks like you just documented this. Not a big deal, then, but it would be nice to be able to use enum values (if this is in fact an enum).
Member
Author
There was a problem hiding this comment.
Noted. I suppose it'd cause far less hassle to everyone involved.
modtools/item-trigger.lua
Outdated
| table.item = df.item.find(item) | ||
| table.unit = df.unit.find(unit) | ||
| if table.item and table.unit then -- they must both be not nil or errors will occur after this point with instant reactions. | ||
| if table.item and table.unit then--they must both be not nil or errors will occur after this point with instant reactions. |
Member
There was a problem hiding this comment.
Spaces around comments make them more readable. No need to remove them.
Member
Author
There was a problem hiding this comment.
My bad, not sure why I did that.
… + other minor corrections as per lethosor's feedback
lethosor
approved these changes
Mar 27, 2018
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Previously, item-trigger's inventory update checks only differentiated between equipping and unequipping items. This means that something like
modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip -command [ foo ]
would trigger foo both in cases where a cap was being worn, and in cases where it was simply being held in the unit’s hand.
With this update, the user will now be able to specify the inventory mode alongside onEquip and onUnequip to allow for greater selectivity. Taking the above example, if we wanted to trigger foo only in cases where a cap was being worn, we could specify this via
modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip 2 -command [ foo ]
or
modtools/item-trigger -itemType ITEM_HELM_CAP -onEquip [ 2 ] -command [ foo ]
where ‘2’ is the mode type corresponding to ‘Worn’.
Multiple inventory modes can be specified. For example,
modtools/item-trigger -itemType RING -onUnequip [ 0 1 2 ] -command [ foo ]
would trigger foo when a ring is unequipped in cases where it was being hauled, held or worn.
A list of inventory mode values has been included in the -help printout.
Specifying mode remains optional, preserving backwards compatibility.