2.2 (Current)
Writing Your Dialogue
Working With Unity
Unity Sample Projects
API Documentation
Variables
The Yarn language is a full programming language, which means it has support for writing code that let you control how the dialogue in your game works. In this section, you'll learn how to use variables to control your dialogue.
Variables
Variables store information. Variables can store one of three types of information: numbers, strings, and booleans.
Type
Possible Values
Examples
Number
Any whole or decimal number
1, 2.5, 3468900, -500
String
Any sequence of letters, numbers and other characters, enclosed in quotes.
"Hello", "✓", "A whole sentence."
Boolean
Either the value true or the value false.
true, false
Every variable has a name. In Yarn Spinner, all variable names start with a dollar sign (
$).Setting Variables
You put information into a variable by using the
<<set>> command. For example, the following code puts a string, "Hello, Yarn!", into a variable called $greeting:1
<<set $greeting to "Hello, Yarn!">>
Copied!
As with node titles, variable names must not contain spaces. They must be made up of only letters, numbers and underscores, and the first character must be a letter.
Variables and Types
Each variable can only store one type of value. Variables can change their value at any time, but they can never change their type.
For example, the following code will work:
1
// Set some initial values in some variables
2
<<set $myCoolNumber to 7>>
3
<<set $myFantasticString to "wow, text!">>
4
5
// Now change them!
6
<<set $myCoolNumber to 8>>
7
<<set $myFantasticString to "incredible!">>
Copied!
This works because while the value of each of the variable changes, the type doesn't. However, the following code will not work:
1
// Set some initial values in some variables
2
<<set $myCoolNumber to 7>>
3
<<set $myFantasticString to "wow, text!">>
4
5
// This will NOT work, because you can't change types!
6
<<set $myCoolNumber to "8">>
7
<<set $myFantasticString to 42>>
Copied!
In earlier versions of Yarn Spinner, variables could also be
null, which represented "no value". Starting with Yarn Spinner 2.0, variables are never null. All variables are required to have a value.1
<<set $variableName to "a string value">>
Copied!
Variables and Expressions
You can work with the values inside variables. For example, numbers can be multiplied, strings can be added together, and boolean values can have logical operations (like and and or) applied to them. When values are used together like this, it's called an expression.
1
<<set $numberOfSidesInATriangle = 2 + 1>>
2
3
<<set $numberOfSidesInASquare = $numberOfSidesInATriangle + 1>>
Copied!
An expression needs to be a single type. You can't work with values of different types in a single expression. For example, the following code will not work:
1
// This will NOT work, because you can't add a string and a number:
2
<<set $broken = "hello" + 1>>
Copied!
Yarn Spinner provides built-in functions for converting between certain types:
- The
stringfunction converts values of any type into a string. - The
numberfunction converts values of any type into a number (if it can be interpreted as one.) - The
boolfunction converts values of any type into a boolean value (if it can be interpreted as one.)
Using Variables in Lines
To show the contents of a variable, you put it inside braces (
{ }) inside a line. The value of that variable will appear in its place.For example:
Snippet
Output
1
<<set $variableName to "a string value">>
2
The value of variableName is {$variableName}.
Copied!
1
The value of variableName is a string value.
Copied!
Variables and Storage
Yarn Spinner doesn’t manage the storage of information in variables itself. Instead, your game provides a variable storage object to Yarn Spinner before you start running dialogue.
When Yarn Spinner needs to know the value of a variable, it will ask the variable storage object you’ve given it. When Yarn Spinner wants to set the value of a variable, it will provide the value and the name of the variable. In this way, your game has control over how data is stored.
The specifics of how variables need to be stored will vary depending on what game engine you're using Yarn Spinner in. To learn more about variable storage in Unity, see Variable Storage.
Last modified 4mo ago
Export as PDF
Copy link
Edit on GitHub