Skip to content

Commit 8cff45e

Browse files
committed
Add store docs
1 parent 9333f35 commit 8cff45e

File tree

7 files changed

+41
-9
lines changed

7 files changed

+41
-9
lines changed

docs/latest/getting-started/register-fact.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ description: |
33
Register a Fact
44
---
55

6-
Facts are resources in Parley used by Condition Nodes for comparisons within the
7-
running game. For example, one might want to display different dialogue
8-
depending on whether Alice gave a coffee or not.
6+
Facts are resources in Parley used by Condition and Match Nodes for comparisons
7+
within the currently running game. For example, one might want to display
8+
different dialogue depending on whether a condition check is passed or not (e.g.
9+
whether Alice gave a coffee or not).
910

1011
Facts are stored in a fact store which can be configured in the Parley settings.
1112

docs/latest/stores/action-store.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
---
22
description: |
3-
An Action Store is: TODO.
3+
An Action Store is a store for actions.
44
---
55

6-
An Action Store is: TODO.
6+
An Action Store is a store for actions. Actions are developer-defined
7+
functionality that will execute during the processing of a Dialogue Sequence.
8+
For example, emitting a signal, registering a journal entry, or updating state.
9+
These are managed and stored in the Parley Action store.
10+
11+
Parley provides the ability for users to manage actions via the `Action` tab in
12+
the `ParleyStore` dock:
13+
14+
![action-store](../../../www/static/docs/action-store/action-store.png)
15+
16+
To find out how to register an action to the store, follow
17+
[this guide](../getting-started/register-action.md).
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
---
22
description: |
3-
A Character Store is: TODO.
3+
A Character Store is a store for characters.
44
---
55

6-
A Character Store is: TODO.
6+
A Character Store is a store for characters. As the name suggests, Characters
7+
are resources in Parley used to define characters within a Dialogue Sequence.
8+
9+
Parley provides the ability for users to manage characters via the `Character`
10+
tab in the `ParleyStore` dock:
11+
12+
![character-store](../../../www/static/docs/character-store/character-store.png)
13+
14+
To find out how to register a character to the store, follow
15+
[this guide](../getting-started/register-character.md).

docs/latest/stores/fact-store.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
---
22
description: |
3-
A Fact Store is: TODO.
3+
A Fact Store is a store for facts.
44
---
55

6-
A Fact Store is: TODO.
6+
A Fact Store is a store for facts. Facts are resources in Parley used by
7+
Condition and Match Nodes for comparisons within the currently running game. For
8+
example, one might want to display different dialogue depending on whether a
9+
condition check is passed or not (e.g. whether Alice gave a coffee or not).
10+
11+
Parley provides the ability for users to manage facts via the `Fact` tab in the
12+
`ParleyStore` dock:
13+
14+
![fact-store](../../../www/static/docs/fact-store/fact-store.png)
15+
16+
To find out how to register a fact to the store, follow
17+
[this guide](../getting-started/register-fact.md).
85.7 KB
Loading
96.1 KB
Loading
87.4 KB
Loading

0 commit comments

Comments
 (0)