Implement JUMP opcode.

Author: weaversam8

README.md

@@ -55,7 +55,7 @@ Only a subset of Yarn Spinner opcodes are currently implemented. This will certa
 | OpCode           | Status                                                 |
 | ---------------- | ------------------------------------------------------ |
 | `JUMP_TO`        | ✅  Implemented in `runner.__jump_to`        |
-| `JUMP`           | 🚫  Not Implemented                          |
+| `JUMP`           | ✅  Implemented in `runner.__jump`           |
 | `RUN_LINE`       | ✅  Implemented in `runner.__run_line`       |
 | `RUN_COMMAND`    | ✅  Implemented in `runner.__run_command`    |
 | `ADD_OPTION`     | ✅  Implemented in `runner.__add_option`     |

examples/shortcuts.csv

@@ -0,0 +1,9 @@
+id,text,file,node,lineNumber
+shortcuts-Start-0,This is a test of shortcut functionality.,shortcuts,Start,3
+shortcuts-Start-1,Option 1,shortcuts,Start,5
+shortcuts-Start-2,Option 2,shortcuts,Start,7
+shortcuts-Start-3,Option 3,shortcuts,Start,9
+shortcuts-Start-4,Option 4,shortcuts,Start,10
+shortcuts-Start-5,Option 1 selected.,shortcuts,Start,6
+shortcuts-Start-6,Option 2 selected.,shortcuts,Start,8
+shortcuts-Start-7,This is the last line.,shortcuts,Start,12

examples/shortcuts.yarn

@@ -0,0 +1,13 @@
+title: Start
+---
+This is a test of shortcut functionality.
+
+-> Option 1
+    Option 1 selected.
+-> Option 2
+    Option 2 selected.
+-> Option 3
+-> Option 4
+
+This is the last line.
+===

examples/shortcuts.yarnc

@@ -0,0 +1,36 @@
+import os
+from .context import YarnRunner
+
+compiled_yarn_f = open(os.path.join(os.path.dirname(
+    __file__), '../examples/shortcuts.yarnc'), 'rb')
+names_csv_f = open(os.path.join(os.path.dirname(
+    __file__), '../examples/shortcuts.csv'), 'r')
+
+runner = YarnRunner(compiled_yarn_f, names_csv_f)
+
+
+def test_start_node_text():
+    assert "This is a test of shortcut functionality." == runner.get_line()
+    assert not runner.has_line()
+    assert not runner.finished
+
+
+def test_start_node_choices():
+    choices = runner.get_choices()
+
+    assert len(choices) == 4
+    assert choices[0]["text"] == "Option 1"
+    assert choices[1]["text"] == "Option 2"
+    assert choices[2]["text"] == "Option 3"
+    assert choices[3]["text"] == "Option 4"
+
+
+def test_shortcuts():
+    runner.choose(0)
+
+    assert "Option 1 selected." == runner.get_line()
+    assert runner.has_line()
+    assert "This is the last line." == runner.get_line()
+    assert not runner.has_line()
+    assert runner.finished
+    assert runner.current_node == 'Start'

tests/test_shortcuts.py

@@ -126,6 +126,15 @@ def __jump_to(self, instruction):
             instruction.operands[0].string_value)
         print(f"to {self._program_counter}")
 
+    def __jump(self, _instruction):
+        if len(self._vm_data_stack) < 1 or type(self._vm_data_stack[0]) != str:
+            raise Exception(
+                "The JUMP opcode requires a string to be on the top of the stack. A string is not currently present.")
+
+        self._program_counter = self.__find_label(
+            self._vm_data_stack[0]
+        )
+
     def __go_to_node(self, node_key):
         # print(f"Go from {self.current_node} to node {node_key}")
         if node_key not in self._compiled_yarn.nodes.keys():
@@ -244,7 +253,7 @@ def noop(instruction):
 
         opcode_functions = {
             Instruction.OpCode.JUMP_TO: self.__jump_to,
-            Instruction.OpCode.JUMP: noop,
+            Instruction.OpCode.JUMP: self.__jump,
             Instruction.OpCode.RUN_LINE: self.__run_line,
             Instruction.OpCode.RUN_COMMAND: self.__run_command,
             Instruction.OpCode.ADD_OPTION: self.__add_option,