A quick reference for obscure features in ink.
A list of tags that can be used with Inky's native web player.
Some of these tags expect a property, in the form of #TAG: property.
Capitalisation matters. These tags will not work if you don't capitalise them as they appear here.
theme
author
AUDIO
AUDIOLOOP
IMAGE
LINK
LINKOPEN
BACKGROUND
CLASS
CLEAR
RESTART
These aren't actually functions, despite the name. These are operations you can use on variables and lists to modify or compare them.
Add : +
Subtract : -
Divide : /
Multiply : *
Mod : %
Negate : _
Equal : ==
Greater : >
Less : <
GreaterThanOrEquals : >=
LessThanOrEquals : <=
NotEquals : !=
Not : !
And : &&
Or : ||
Min : MIN
Max : MAX
Pow : POW
Floor : FLOOR
Ceiling : CEILING
Int : INT
Float : FLOAT
Has : ?
Hasnt : !?
Intersect : ^
ListMin : LIST_MIN
ListMax : LIST_MAX
All : LIST_ALL
Count : LIST_COUNT
ValueOfList : LIST_VALUE
Invert : LIST_INVERT
You can use the plain text version of these operations, rather than the symbol.
It's recommended that you use "not" over "!", since "!" can perform other functions in ink, and may lead to syntax errors.
&& : and
|| : or
% : mod
! : not
? : has
!? : hasnt
These must be called as functions. Will return a value.
CHOICE_COUNT
TURNS_SINCE
TURNS
RANDOM
SEED_RANDOM
LIST_VALUE
LIST_RANDOM
READ_COUNT
Not necessary unless you're doing some truly wild things with the ink runtime. Current as of inkjs 2.2.0.
-1 : NotSet
0 : EvalStart
1 : EvalOutput
2 : EvalEnd
3 : Duplicate
4 : PopEvaluatedValue
5 : PopFunction
6 : PopTunnel
7 : BeginString
8 : EndString
9 : NoOp
10 : ChoiceCount
11 : Turns
12 : TurnsSince
13 : ReadCount
14 : Random
15 : SeedRandom
16 : VisitIndex
17 : SequenceShuffleIndex
18 : StartThread
19 : Done
20 : End
21 : ListFromInt
22 : ListRange
23 : ListRandom
24 : BeginTag
25 : EndTag
26 : TOTAL_VALUES