archives/AIDScripting
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added inventory to readme

Browse source
This commit is contained in:
Matt Brockman 2021-01-14 19:08:10 -08:00
parent 3055a7caac
commit 3f5bc78910
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -54,6 +54,9 @@ The `state` variable can be used to store information that's persistent across f
who should see the message. E.g., `[{ text: 'Only you can see this!', visibleTo: ['Sam', 'Jane']}]`
* The `state.memory.context` value will replace the user defined memory if it exists
* `state.displayStats` takes an array of objects [{key, value, color}] which will be displayed for users in the score section as [key]: [value] in the preferred color (defaults to user color). See https://github.com/latitudegames/Scripting/blob/master/examples/showTextLength.js for an example.
* `state.inventory` takes an array of objects [{name, quantity}] which will be make the inventory option available in the adventure menu (right). For now, this just displays all items and thier quantities from the inventory.
See https://github.com/latitudegames/Scripting/blob/master/examples/addSimpleInventory.js for an example.
* `state.currentRobot` is the currently assigned scoreBot. Changing this to an available bot will request that bot to do scoring. Available bots are [`KillBot`, `JudgeBot`, `EmpathyBot`, `SuccessBot`] - expect changes to the scoring on the bots as well as the messages produced by them. If the requested bot is unavailable no score changes will be returned.
* You can set any variable on state to store and modify adventures throughout an adventure.