0.13.0

[nndda]

(WIP changelogs)

0.13.0

Another big, breaking, and exciting changes and updates.

New

• Dialogue: nested scope access is now possible! (Nested scope property #118)
  Before, you could only access the direct properties/methods of a scope.

  Scope.property = value
  Scope.method(args)

  Now, you can access any arbitrary deep properties of a scope.

  Scope.object.property = value
  Scope.object.another_object.method(args)

• Dialogue: added dialogue line attribute data. (Dialogue line attribute #133)
  Metadata/attributes thingy for each line of the dialogue. For those who prefers declarative stuff:

  Dia:
      $portrait = "dia_happy.png"
      $voice_line = "dia_1.wav"
  
      "Welcome! to the Theatre!"

  And then, on the dialogue data:

  {
      ...,
      Key.ATTR: {
          "portrait": "dia_happy.png",
          "voice_line": "dia_1.wav"
      }
  }

• Stage: func_call_filter property. (Add function call interceptor from user-defined callable #132)
  A Callable that intercept function calls made from the dialogue, and choose whether to execute it or not.
  If it returns true, the function gets executed. Otherwise, the function will be skipped.

  Use cases (that I could think of):

  • Sandboxing. Disallow certain methods or properties to be manipulated on certain scopes.
  • State managing. Allows for one-time use of functions.

  Example:

  func foo(func_data):
      # Skip function calls from Dialogue that calls `OS.execute()`
      if func_data[Dialogue.FUNC_SCOPE] == "OS" and\
         func_data[Dialogue.FUNC_NAME] == "execute":
              return false
  
      return true

  And then:

  stage.func_call_filter = foo

• Stage: function_called signal.

  function_called(func_data: Dictionary, executed: bool)

  Emitted when, well, a function is called. It also give you its function, and an executed status: whether the function was called or not.

• Dialogue: {jump} dialogue tags.
  Render the whole block of text wrapped in this tag immediately, all at once.

  Ritsu:
      "Wait wait wait...{d=0.5} you did {jump}WHAT??!!{/jump}"

• Dialogue: Both {delay} and {speed} tags now have defaults value, that can be configured in the project setting.
  If you used certain value frequently, instead of inserting it over and over like this:

  Dia:
     "One,{d=1.2} two,{d=1.2} three,{d=1.2} aaaand..."

  You can set 1.2 as the default value, and just insert the {d}:

  Dia:
     "One,{d} two,{d} three,{d} aaaand..."

• General: You can now disable/enable Theatre's header print (the 🎭 Theatre v<version> by nnda stuff) in the project settings, at theatre/general/print_header.

• Parser: There's now parser benchmark, that measures how fast the parser compiles the written dialogue file. You can see the results from the GitHub Actions workflow logs here.

Changes

• Stage: [BREAKING] Removed the old Stage class.

• Stage: [BREAKING] Removed the deprecated caller-named methods.

• Config: [BREAKING] Multi-thread parser import option now moved to theatre/parser.

• General: Theatre version is now tracked in your project internally. (Use internal ProjectSettings over .theatre file #119)

• Tons of bug fixes and performance improvements.