mirror of
https://github.com/Oreolek/ink-instead.git
synced 2024-05-11 13:38:24 +03:00
Update README.md
This commit is contained in:
parent
faedb6a3be
commit
bbdbd087d4
17
README.md
17
README.md
|
@ -17,16 +17,27 @@ _Ink is inkle's scripting language for writing interactive narrative, both for t
|
||||||
- Diverts
|
- Diverts
|
||||||
- Glue
|
- Glue
|
||||||
- Include
|
- Include
|
||||||
|
- Tags
|
||||||
|
|
||||||
### Runtime
|
### Runtime API
|
||||||
- state.visitCountAtPathString() - allows the runtime to check if the story went through a scpecific point
|
```lua
|
||||||
|
boolean story.canContinue
|
||||||
|
nil story.continue()
|
||||||
|
table story.currentChoices
|
||||||
|
nil story.chooseChoiceIndex(index)
|
||||||
|
nil story.choosePathString(path)
|
||||||
|
table story.globalTags
|
||||||
|
table story.tagsForContentAtPath(path)
|
||||||
|
table story.currentTags
|
||||||
|
number story.state.visitCountAtPathString(path)
|
||||||
|
```
|
||||||
|
|
||||||
See [WritingWithInk](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md) and [RunningYourInk](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md) for the description of the reference ink implementation.
|
See [WritingWithInk](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md) and [RunningYourInk](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md) for the description of the reference ink implementation.
|
||||||
|
|
||||||
## Used by
|
## Used by
|
||||||
pink is used by my small game https://github.com/premek/enjoy
|
pink is used by my small game https://github.com/premek/enjoy
|
||||||
|
|
||||||
Let me know if you want to use it too.
|
Let me know if you want to use it too - or just use it!
|
||||||
|
|
||||||
## Install dependencies
|
## Install dependencies
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue