Skip to content

Commit

Permalink
Document per-user and ephemeral vars
Browse files Browse the repository at this point in the history
  • Loading branch information
Rosuav committed Jun 23, 2023
1 parent 894ee3d commit 8c65d45
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Substitutions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ notations can be used to include this information in your messages:

* $varname$ - variables created by and for your own channel. For example,
you might have a counter for the number of times you've died: $deaths$
* $*varname$ - variables associated with the current user (within this
channel). These are tracked separately for all users that use them.
* $kwd*varname$ - variables associated with a specific user - see the
"User Vars" builtin to specify the user
* $varname?$ - ephemeral variables which can be accessed identically to
others, but are not saved across bot restarts. These may disappear at
any time, but will usually stick around for months. They will not be
shown in the /variables page for the channel. Note that this can be
combined with per-user notation also, creating a per-user ephemeral.
* {token} - information provided by a builtin or special trigger. When a
command calls on a builtin, it will receive a specific set of keywords
which can be used in this way.
Expand Down

0 comments on commit 8c65d45

Please sign in to comment.