Document shared library

This commit is contained in:
Devon7925 2020-09-22 18:40:17 -06:00 committed by GitHub
parent 2dfd05d42b
commit 605ce7222c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -26,6 +26,9 @@ As an example, if you set `state.memory.authorsNote` to `the following paragraph
### Quests ### Quests
You can modify the quests property to change the quests of the adventure mid game. You can modify the quests property to change the quests of the adventure mid game.
### Shared Library
Appended to the other three scripts so you can use the same code between all three.
### Input Modifier ### Input Modifier
Called each time the player gives an input and has the opportunity to modify that input. Called each time the player gives an input and has the opportunity to modify that input.
@ -56,4 +59,4 @@ The `state` variable can be used to store information that's persistent across f
`info` contains some useful values, depending on which modifier you're in. `info` contains some useful values, depending on which modifier you're in.
All modifiers have access to `info.actionCount`, the number of actions in the adventure so far. All modifiers have access to `info.actionCount`, the number of actions in the adventure so far.
When in a Context Modifier, `info.memoryLength` and `info.maxChars` are also set, indicating the length of the memory portion of text (if any), and the total allowed length of the context after which it will be truncated. When in a Context Modifier, `info.memoryLength` and `info.maxChars` are also set, indicating the length of the memory portion of text (if any), and the total allowed length of the context after which it will be truncated.