[API] List and Toggle Equipment (5e OGL)

August 24 (7 years ago)

Permalink Quote

It looks like there are several API that do very fancy things with Inventory items, and that some have been around a long time (old?). I am looking for an API that will help the GM & Players quickly see what inventory items are set to "Equipped," and to toggle them on/off from chat. Is there an API that will:

Output to Chat a character's Inventory, showing the item name and its "Equipped" status, (e.g. yes or no)
Allow the user to toggle the item's Equipped state

I'd like to "see" what a character's got going on without having to open the "information" layer for each item on the character sheet (or without even opening the sheet). For characters who are repeatedly equipping/stowing shields or donning disguises all the time, it can be quite onerous to determine all the inventory items acting on the character sheet -- especially if you've got a group of players who pick up every stick they come across in the daggone forest.

August 24 (7 years ago)

Permalink Quote

Try this out
https://gist.github.com/oukag/bf92a517e7dfb2f1ce94b0e46e695d92

August 25 (7 years ago)

Permalink Quote

Hey, tried this out, but it doesn't do anything. Did it work for you?
Regards

August 25 (7 years ago)

Permalink Quote

Did you run either of the two commands?

!equipShow with a selected token
!equipToggle --charid|@{selected|character_id} --item|<ITEM_NAME>

August 25 (7 years ago)

Permalink Quote

Thanks Kyle. This is really great. The script is properly displaying all the Equipped items. However, using the !equipToggle, or clicking an item name in the !equipShow list does not seem to be toggling all the necessary attributes in the inventory.

The script is tripping the equipflag (greying out the item in the inv list), but not the check box, and it is not removing the item mod affects (e.g. AC bonus). Then all these states are weirdly out of sync.

This is the same challenge I encountered while trying to figure out the Equipment toggler system in my console tests. -- where toggling the flag doesn't have a cascading affect on all the related attribute states & in the sheet html, the way it does when you trigger them through the sheet itself.

August 25 (7 years ago)

Permalink Quote

Thanks for pointing that out, I'll see what I can do. The checkbox is a simple fix (I didn't realize there were two attributes that govern if an item is equipped or not), but I get the feeling that the auto-update for ac and such will require recreating the update process in the script rather than tricking the character sheet into think that it was manually changed.

August 25 (7 years ago)

Sheet Author

API Scripter

Permalink Quote

Kyle G. said:
Thanks for pointing that out, I'll see what I can do. The checkbox is a simple fix (I didn't realize there were two attributes that govern if an item is equipped or not), but I get the feeling that the auto-update for ac and such will require recreating the update process in the script rather than tricking the character sheet into think that it was manually changed.

If you use attr.setWithWorker() instead of attr.set(), it should work properly.

August 25 (7 years ago)

Permalink Quote

Jakob said:
If you use attr.setWithWorker() instead of attr.set(), it should work properly.

That's awesome. I normally work with custom attributes so I didn't even know that setWithWorker existed.

Alright Chris, try it now

August 25 (7 years ago)

Permalink Quote

On it!

August 25 (7 years ago)

Permalink Quote

Ok I've tested the new version. Switching to setWithWorker has solved the syncing issue, so now toggling the eq fires all the relevant sheet attributes. Here is what's happening now:

activate the script with !equipShow -- I get the right list of equipped items displayed in chat
When clicking an item in the chat output list of equipped items, the script reports that the character "has equipped the item." (the item's equip status is not changed). So the first toggling does not change the eq equipped state.
Curiously, if I click again, the script does unequip the item, and it properly reports that the item is unequipped, with all the display attributes in sync.

It's nearly working!

August 25 (7 years ago)

Permalink Quote

Alright, that change should have fixed it. I made the comparison to see if the item is equipped a little bit more lax. The character sheet requires that it be a string rather than a number, but for some reason the value is a number and not a string by default.

August 26 (7 years ago)

Edited August 26 (7 years ago)

Permalink Quote

Kyle G. said:
Did you run either of the two commands?
!equipShow with a selected token
!equipToggle --charid|@{selected|character_id} --item|<ITEM_NAME>

Hey,

yes I did. Had to set up the token again and now it works : )

Is there a way to add new items via macro?

Regards

August 26 (7 years ago)

Permalink Quote

Hey Kyle, I tested the script with a bunch of use situations, and it's working great. Would you mind switching the chat output so everything is whispered?

August 26 (7 years ago)

Permalink Quote

pale81 said:
Kyle G. said:
Did you run either of the two commands?
!equipShow with a selected token
!equipToggle --charid|@{selected|character_id} --item|<ITEM_NAME>

Is there a way to add new items via macro?

You could do that with ChatSetAttr and setting the individual attributes for the item, but I'll see how much work is required to condense it into a single command.

Chris said:

Would you mind switching the chat output so everything is whispered?

Done

August 26 (7 years ago)

Permalink Quote

I tried it with ChatSetAttr a few weeks ago.
I get it to work, but only with a special "Inventory" attribute, not with the "regular" Inventory.

August 27 (7 years ago)

Permalink Quote

Thanks Kyle. This is excellent!

August 27 (7 years ago)

Sheet Author

API Scripter

Permalink Quote

pale81 said:
I tried it with ChatSetAttr a few weeks ago.
I get it to work, but only with a special "Inventory" attribute, not with the "regular" Inventory.

!setattr [--sel | --charid <ids> | --name <names> | ...] {{
 --repeating_inventory_-create_itemname|Stuff
 --repeating_inventory_-create_itemcount|5
 --repeating_inventory_-create_itemweight|7
}}

August 28 (7 years ago)

Edited August 28 (7 years ago)

Permalink Quote

Holy Shit, I tried a lot of things and waste a lot of time and it's that easy? I feel really stupid ; )
Is there a way to do the same for the attack & spell section above the inventory?

Regards

August 28 (7 years ago)

Permalink Quote

Yup, you just have to use know the attributes for the attack and spell. You can find the attributes by looking at the code for the 5e OGL character sheet on the Roll20 github and looking for the specific sections (repeating_attack and repeating_spell-SPELLLEVEL).

Note that spells are different than items and attacks because the attribute names also include the spell level. For example repeating_spell-cantrip_ROWID or repeating_spell-1_ROWID

August 31 (7 years ago)

Permalink Quote

Very nice, i‘ll have to try that thank you all

August 31 (7 years ago)

Plus

Permalink Quote

Nice little script!
One other enhancement that could be useful, check status of a single item, something like this ...
!equipShow –item|<ITEM_NAME>

October 12 (7 years ago)

Permalink Quote

Hey,

is there a way to change (not only to create) item attributes?

!setattr [--sel | --charid <ids> | --name <names> | ...] {{
 --repeating_inventory_-create_itemname|Stuff
 --repeating_inventory_-create_itemcount|5
 --repeating_inventory_-create_itemweight|7
}}

Used this to create them, but how to change for example the stuff item count to 4 afterwards, with an macro?

Thank you and regards

October 13 (7 years ago)

Permalink Quote

Mark R. said:
Nice little script!
One other enhancement that could be useful, check status of a single item, something like this ...
!equipShow –item|<ITEM_NAME>

Just noticed your comment, I have added this functionality to the latest revision. Sorry for taking so long.

pale81 said:

Hey,

is there a way to change (not only to create) item attributes?
!setattr [--sel | --charid <ids> | --name <names> | ...] {{
 --repeating_inventory_-create_itemname|Stuff
 --repeating_inventory_-create_itemcount|5
 --repeating_inventory_-create_itemweight|7
}}
Used this to create them, but how to change for example the stuff item count to 4 afterwards, with an macro?

Thank you and regards

Yes, you would simply replace -create in repeating_inventory_-create_ATTR with the row ID of the item you are modifying. I believe that Jakob has even accounted for putting the in index ($X) for the row ID if you prefer to not have to find the row ID first.

As for whether I would add that functionality to this script, probably not. There are a number of other scripts that can be utilized for such a task. The 5e OGL companion can keep track of resources and you could also use The Aaron's Ammo script I believe.

October 13 (7 years ago)

Plus

Permalink Quote

Awesome, thanks! I have a macro for players that calls this script to don/doff a shield (which auto adjusts their AC). !equipShow –item|shield will let them check current status.

October 14 (7 years ago)

Plus

Permalink Quote

Looks like the latest version is no longer outputting to chat. Is that intended?

October 14 (7 years ago)

Permalink Quote

No, are you getting any errors?

October 15 (7 years ago)

Plus

Permalink Quote

No errors, but after investigating it's just for one of my campaigns; un-Equips/Equips the item but does not output to chat. I guess I have an api conflict for the one but not the others. But, have the same scripts implemented. The original script does output to chat in the problem campaign, but not the latest script. Strange.

1

You must Login to your Roll20 Account to post a reply.