package Yarn

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Node

• string key = 1

  The name of the header.

• string value = 2

  The value of the header.

Used in: Node

• oneof InstructionType

  • Instruction.JumpToInstruction jumpTo = 1

    Jumps to a specified position in the current node.

  • Instruction.PeekAndJumpInstruction peekAndJump = 2

    Peeks a number on the stack, and jumps to that position in the current node.

  • Instruction.RunLineInstruction runLine = 3

    Runs a line of dialogue.

  • Instruction.RunCommandInstruction runCommand = 4

    Runs a command.

  • Instruction.AddOptionInstruction addOption = 5

    Adds an option to the 'pending options' list.

  • Instruction.ShowOptionsInstruction showOptions = 6

    Shows all options in the 'pending options' list, then clears the list.

  • Instruction.PushStringInstruction pushString = 7

    Pushes a string onto the stack.

  • Instruction.PushFloatInstruction pushFloat = 8

    Pushes a floating point number onto the stack.

  • Instruction.PushBoolInstruction pushBool = 9

    Pushes a boolean onto the stack.

  • Instruction.JumpIfFalseInstruction jumpIfFalse = 10

    Peeks a boolean on the stack, and if it's false, jumps to the indicated position in the current node.

  • Instruction.PopInstruction pop = 11

    Pops a value of any kind off the stack.

  • Instruction.CallFunctionInstruction callFunc = 12

    Calls a named function.

  • Instruction.PushVariableInstruction pushVariable = 13

    Pushes the value of the named variable onto the stack.

  • Instruction.StoreVariableInstruction storeVariable = 14

    Peeks a value of any kind on the stack, and stores it in the indicated variable.

  • Instruction.StopInstruction stop = 15

    Halts execution.

  • Instruction.RunNodeInstruction runNode = 16

    Jumps to the start of a named node.

  • Instruction.PeekAndRunNodeInstruction peekAndRunNode = 17

    Peeks a string on the stack, and jumps to the start of that node.

  • Instruction.DetourToNodeInstruction detourToNode = 18

  • Instruction.PeekAndDetourToNode peekAndDetourToNode = 19

  • Instruction.ReturnInstruction return = 20

  • Instruction.AddSaliencyCandidateInstruction addSaliencyCandidate = 21

    Pops a boolean from the stack, and adds a saliency candidate to the current list.

  • Instruction.AddSaliencyCandidateFromNodeInstruction addSaliencyCandidateFromNode = 22

    Add a saliency candidate to the current list, given a node name.

  • Instruction.SelectSaliencyCandidateInstruction selectSaliencyCandidate = 23

    Attempt to select a single saliency candidate from the current list: - if one is selected, pushes the destination of that candidate and the value 'true' - if none is selected, pushes the value 'false' In all circumstances, clears the saliency candidate list before returning.

Used in: Instruction

• string lineID = 1

  The ID of the content that should be shown for this option.

• int32 destination = 2

  The instruction number in the current node to jump to if this option is selected.

• int32 substitutionCount = 3

  The number of substitutions present in this option that must be popped off the stack.

• bool hasCondition = 4

  A value indicating whether this instruction has a line condition on it, whose evaluated value must be popped off the stack.

Used in: Instruction

• string nodeName = 1

  The name of the node to get saliency information from.

• int32 destination = 2

  The instruction number in the current node to jump to if this candidate is selected.

Used in: Instruction

• string contentID = 1

  The unique ID for this piece of content, such as a line ID.

• int32 complexityScore = 2

  The complexity score of the candidate.

• int32 destination = 3

  The instruction number in the current node to jump to if this candidate is selected.

Used in: Instruction

• string functionName = 1

  The name of the function to call.

Used in: Instruction

• string nodeName = 1

Used in: Instruction

• int32 destination = 1

  The instruction number in the current node to jump to.

Used in: Instruction

• int32 destination = 1

  The instruction number in the current node to jump to.

Used in: Instruction

(message has no fields)

Used in: Instruction

(message has no fields)

Used in: Instruction

(message has no fields)

Used in: Instruction

(message has no fields)

Used in: Instruction

• bool value = 1

  The value to push.

Used in: Instruction

• float value = 1

  The value to push.

Used in: Instruction

• string value = 1

  The value to push.

Used in: Instruction

• string variableName = 1

  The name of the variable whose value should be pushed onto the stack.

Used in: Instruction

(message has no fields)

Used in: Instruction

• string commandText = 1

  The text of the command to send to the client.

• int32 substitutionCount = 2

  The number of substitutions present in this command that must be popped off the stack.

Used in: Instruction

• string lineID = 1

  The ID of the localised content that should be shown for this line.

• int32 substitutionCount = 2

  The number of substitutions present in this line that must be popped off the stack.

Used in: Instruction

• string nodeName = 1

  The name of the node to begin running.

Used in: Instruction

(message has no fields)

Used in: Instruction

(message has no fields)

Used in: Instruction

(message has no fields)

Used in: Instruction

• string variableName = 1

  The name of the variable whose value should be updated with the value currently on top of the stack.

A single Yarn instruction.

• InstructionV1.OpCode opcode = 1

  The operation that this instruction will perform.

• repeated Operand operands = 2

  The list of operands, if any, that this instruction uses.

The type of instruction that this is.

Used in: InstructionV1

• JUMP_TO = 0

  Jumps to a named position in the node. opA = string: label name

• JUMP = 1

  Peeks a string from stack, and jumps to that named position in the node. No operands.

• RUN_LINE = 2

  Delivers a string ID to the client. opA = string: string ID

• RUN_COMMAND = 3

  Delivers a command to the client. opA = string: command text

• ADD_OPTION = 4

  Adds an entry to the option list (see ShowOptions). - opA = string: string ID for option to add - opB = string: destination to go to if this option is selected - opC = number: number of expressions on the stack to insert into the line - opD = bool: whether the option has a condition on it (in which case a value should be popped off the stack and used to signal the game that the option should be not available)

• SHOW_OPTIONS = 5

  Presents the current list of options to the client, then clears the list. The most recently selected option will be on the top of the stack when execution resumes. No operands.

• PUSH_STRING = 6

  Pushes a string onto the stack. opA = string: the string to push to the stack.

• PUSH_FLOAT = 7

  Pushes a floating point number onto the stack. opA = float: number to push to stack

• PUSH_BOOL = 8

  Pushes a boolean onto the stack. opA = bool: the bool to push to stack

• PUSH_NULL = 9

  Pushes a null value onto the stack. No operands.

• JUMP_IF_FALSE = 10

  Jumps to the named position in the the node, if the top of the stack is not null, zero or false. opA = string: label name

• POP = 11

  Discards top of stack. No operands.

• CALL_FUNC = 12

  Calls a function in the client. Pops as many arguments as the client indicates the function receives, and the result (if any) is pushed to the stack. opA = string: name of the function

• PUSH_VARIABLE = 13

  Pushes the contents of a variable onto the stack. opA = name of variable

• STORE_VARIABLE = 14

  Stores the contents of the top of the stack in the named variable. opA = name of variable

• STOP = 15

  Stops execution of the program. No operands.

• RUN_NODE = 16

  Pops a string off the top of the stack, and runs the node with that name. No operands.

A collection of instructions

Used in: Program

• string name = 1

  The name of this node.

• repeated Instruction instructions = 7

  The list of instructions in this node.

• repeated Header headers = 6

  The headers present on this node.

A value used by an Instruction.

Used in: InstructionV1, Program

• oneof value

  The type of operand this is.

  • string string_value = 1

    A string.

  • bool bool_value = 2

    A boolean (true or false).

  • float float_value = 3

    A floating point number.

A complete Yarn program.

• string name = 1

  The name of the program.

• map<string, Node> nodes = 2

  The collection of nodes in this program.

• map<string, Operand> initial_values = 3

  The collection of initial values for variables; if a PUSH_VARIABLE instruction is run, and the value is not found in the storage, this value will be used