add inputBot

This commit is contained in:
Matt Brockman 2021-01-17 11:02:44 -08:00
parent 1dc475d846
commit d4806f6311

View file

@ -57,6 +57,7 @@ The `state` variable can be used to store information that's persistent across f
* `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. * `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. See https://github.com/latitudegames/Scripting/blob/master/examples/addSimpleInventory.js for an example.
* `state.evaluationBot` uses an evlation bot to assess latest actions and convert it to machine readable formats. The results of the `evaluationBot` are returned in `info.evaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `loot` or `health`. See https://github.com/latitudegames/Scripting/blob/master/examples/evaluationBots.js for usage and available bots. * `state.evaluationBot` uses an evlation bot to assess latest actions and convert it to machine readable formats. The results of the `evaluationBot` are returned in `info.evaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `loot` or `health`. See https://github.com/latitudegames/Scripting/blob/master/examples/evaluationBots.js for usage and available bots.
* `state.inputBot` uses an evlation bot to assess the input and convert it to machine readable formats for conducting functions such as skill checks in the context. The results of the `inputBot` are returned in `info.inputEvaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `DC` or `skill`. See https://github.com/latitudegames/Scripting/blob/master/examples/inputBot.js for usage and available bots.
* `state.skills` is a dictionary {...values, skill(str):level(int)}. A value in state.skills will enable the skills overlay in the adventure menu. The skills overlay allows players to allocate `skillPoints` or learn `random skills` which can be set with the following parameters: * `state.skills` is a dictionary {...values, skill(str):level(int)}. A value in state.skills will enable the skills overlay in the adventure menu. The skills overlay allows players to allocate `skillPoints` or learn `random skills` which can be set with the following parameters:
* `state.disableRandomSkill` disables the user from learning random skills in the screen * `state.disableRandomSkill` disables the user from learning random skills in the screen
* `state.skillPoints` sets the number of skill points a player has available. * `state.skillPoints` sets the number of skill points a player has available.