ink knot (or label)

As explained in the official documentation of the ink language:

The story is comprised of multiple linked sections which we call "knots" in ink terminology. The start of a knot is indicated in ink using at least two equals signs the left hand side knot's name, and optionally on the right too (so for example === london ===).

In the Pixi’VN library, a knot corresponds to a label. The ink + Pixi’VN integration, in addition to giving the possibility to run ink nodes, also allows you to call knots (or labels) written in another narrative language or Javascript/TypeScript.

To run a knot (or label) you can use the following methods:

Use the -> symbol

You can start a knot using the -> symbol. Write the -> symbol followed by the name of the knot, for example:

=== start ===
Start
-> after 

=== after ===
After
End
-> DONE

This feature derives from native ink and is the only native method to start a knot. So, if you test your script using Inky, you will be able to use this feature.

It corresponds to the jump functionality in the Pixi’VN library.

As said before you can use the -> symbol to call a knot written in another narrative language or Javascript/TypeScript, but if you're using Inky to test your script, Inky will warn you that the knot does not exist (because Inky analyzes only the .ink file).

It is for this very reason that the need for a new script arises which is ignored by Inky but is handled by Pixi’VN. This script is the # jump.

Use the jump script

You can start a knot using the # jump. Write # jump followed by the name of the knot, for example:

=== start ===
Start
# jump javascript_label_id 
Start End
-> DONE

This feature has been added by ink + Pixi’VN integration.

# jump is equivalent to the -> symbol. The difference is that this script is ignored by Inky, so you can use it to call a knot written in another narrative language or Javascript/TypeScript without Inky warning you that the knot does not exist.

Use the call script

The native ink language does not have a possibility to "call" a knot without close the current knot and open the new one. This is why the ink + Pixi’VN integration introduces the # call script. This script is ignored by Inky.

Write # call followed by the name of the knot, for example:

=== start ===
Start
# call javascript_label_id 
Start End
-> DONE