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

Update README.md

Browse source
This commit is contained in:
Matt Brockman 2021-01-14 15:15:25 -08:00 • committed by GitHub
parent 725b2e1bcc
commit 7136dd2f8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -52,8 +52,9 @@ The `state` variable can be used to store information that's persistent across f
* The `state.message`, if provided, can be a string that will be displayed as an alert in the game. * The `state.message`, if provided, can be a string that will be displayed as an alert in the game.
When in 3rd person mode, `state.message` can also be an object (or an array of objects) with a list of the multiplayer character names When in 3rd person mode, `state.message` can also be an object (or an array of objects) with a list of the multiplayer character names
who should see the message. E.g., `[{ text: 'Only you can see this!', visibleTo: ['Sam', 'Jane']}]` who should see the message. E.g., `[{ text: 'Only you can see this!', visibleTo: ['Sam', 'Jane']}]`
* `state.score` provides the current game score * The `state.memory.context` value will replace the user defined memory if it exists
* `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 the user's default ScoreBot will be used. * `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)
* `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. * You can set any variable on state to store and modify adventures throughout an adventure.
## Console ## Console