From 1fc240c280075751e3cfb6ec0357f3be22bd5360 Mon Sep 17 00:00:00 2001 From: Nick Walton Date: Sat, 23 May 2020 21:59:43 -0600 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3f3b53..7bd0c00 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# Scripting \ No newline at end of file +# Scripting + +### Input Modifier +Called each time the player gives an input and has the opportunity to modify that input. + +### Output Modifier +Called each time the model generates an output and has the opportunity to modify that output. + +### State +The `state` variable can be used to store information that's persistent across function calls. The state.memory.context value will be added to the games memory if it exists + +### Console +`console.log("Some message")` will log messages that you can see in the scripting console + +### Utils +`const questCompleted = await utils.checkQuestCompleted({history, quest, text})` can be used to check whether a quest was completed.