Skip to content

Latest commit

 

History

History
238 lines (180 loc) · 8.22 KB

CHANGELOG.md

File metadata and controls

238 lines (180 loc) · 8.22 KB
Raw

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

Added

  • Added a ScriptedImporter to import files with the .rumor extension as TextAssets
  • Added .asmdef files, which should prevent Rumor from being repeatedly recompiled when used as a submodule in a Unity Project

3.0.1 - 2018-11-06

Fixed

  • Fix true and false always being treated as variables when they should be a boolean literal
  • Fix scope serialization not working when .NET 4.x runtime is selected

3.0.0 - 2018-09-29

Changed

  • == now only works when comparing values of the same type, with the notable exception of Int and Floats which can be compared to each other.

Fixed

  • Fix compilation error when comment directly follows a statement expecting a block
  • Fix pauses not ending if a choice has been picked
  • Better parsing errors
  • Allow function and variable names to start with keywords
  • Fix math operator precedence
  • null + null returns null instead of throwing InvalidOperationException
  • Fix comparing any non-empty string with another, different non-empty string with == would always return true instead of false
  • Fix >= and <= not working due to comparing the wrapper type instead of the wrapped values
  • Fix using ! on a non-null object would throw an exception
  • clear choices and clear dialog compile instead of throwing a compilation error

2.0.1 - 2018-04-15

Changed

  • Compiler performance improvements

Fixed

  • Fix elif and else compilation errors

2.0.0 - 2018-01-15

Added

  • You can now add the enum argument cant_skip to the end of a pause statement to ignore advances until the pause ends
  • You can now add the enum argument no_wait to the end of an add or say statement to auto advance the dialog
  • Variable substitution with { and } in strings is now supported

Changed

  • The compiler no longer uses a tokenizer except when parsing expressions
  • Compiler errors are more specific and descriptive
  • The Exodrifter.Rumor.Lang namespace has been renamed to Exodrifter.Rumor.Language
  • All unit tests and examples are wrapped in a UNITY_EDITOR ifdef to make it easier to use this repository as a submodule in non-unity project
  • Bindings are no longer stored in Rumor; instead, it is now stored in Bindings
  • Rumor.Run has been renamed to Rumor.Start in order to match the language used in C# Thread.Start and Unity's StartCoroutine method to improve consistency

1.1.2 - 2017-12-23

Changed

  • More descriptive error for tokens after string

Fixed

  • If conditional statements no longer require a following else or elif statement
  • Compiler tokenizes commas correctly now

1.1.1 - 2017-12-23

Added

  • Full Unity scene example

Fixed

  • Fix +=, -=, *=, /= operators not working
  • Fix exception when script execution finishes in some cases

1.1.0 - 2017-12-19

Added

  • Added OnAddChoice and OnRemoveChoice events to RumorState

Fixed

  • Fix unit test failures caused by Tokenize performance optimization code
  • Fix Rumor bindings no longer attempting to convert arguments

1.0.1 - 2017-12-19

Changed

  • Rumor.CallBinding no longer calls DynamicInvoke and is much faster
  • Tokenize step of compilation is much faster

Fixed

  • Fix Rumor.Choosing throwing an error if Rumor has not been started
  • Fix scope not being initialized when passed as null when constructing Rumor
  • Fix Add statements behaving like Say statements
  • Fix null pointer exception in Equals expression
  • Fix incorrect equality checking
  • Fix improper deserialization of values caused by wrapper types (Json.NET will wrap object values in its own type, JValue, which causes logic to fail)
  • Rumor no longer clears the scope when starting
  • Null ObjectValues are now treated the same as an uninitialized (null) variable

1.0.0 - 2017-08-16

Added

  • Added the ability to specify a clear for just dialog or just choices
  • Added the default binding _choice, which returns the contents of the last chosen choice
  • Added the -=, +=, /=, and *= assignment operators
  • Added the <, <=, >, and >= comparison operators

Changed

  • The OnClear event in RumorState has been changed to use a ClearType enum, which specifies if everything, just choices, or just dialog was cleared
  • The Pause command will now wait for an advance if the time is less than or equal to 0
  • Multiple methods of the same name can be binded as long as they have a different number of input parameters

0.2.1 - 2016-11-14

Added

  • Added an OnDialogAdd, OnDialogSet, and OnClear events to RumorState
  • Added the Clear command
  • Added an OnWaitForAdvance and OnWaitForChoose event to Rumor
  • Added a Cancelled property to Rumor

Changed

  • AutoAdvance is now a time instead of a toggle, which indicates the amount of time before the Rumor will attempt to automatically advance
  • Bindings are now stored in the Rumor instead of the Scope

Fixed

  • Fix null variables not handled properly in expressions
  • Fix no boolean literals parsing in RumorCompiler
  • Fix nodes not checking for null values
  • Fix If conditional not checking for null values

0.2.0 - 2016-11-05

Added

  • Added an AutoAdvance property to Rumor that causes it to automatically advance if possible
  • Added Cancel and Finish methods to Rumor
  • Added CancelCount and FinishCount properties to Rumor
  • Added a Choose node
  • Added the ability to use one-line comments

Changed

  • Added SetupDefaultBindings convenience method to Rumor for common bindings
  • Choice nodes no longer automatically wait for a choice at the end of a chain of choices. Instead, use the Choose node to wait for a choice

0.1.1 - 2016-10-31

Added

  • Added a Running property to Rumor
  • Added OnStart and OnFinish events to Rumor
  • Added OnVarSet event to Scope

Changed

  • Rumor.Run() will restart the script instead of throwing an exception if it is already running
  • JumpToLabel and CallLabel are now exposed publicly, and work even if the Rumor has not been started yet
  • Rumor constructors now provide a convenience method that takes a string directly
  • You can now pass Rumor a scope to use

Removed

  • The RumorCodeExample has been removed as it's potentially misleading/confusing

0.1.0 - 2016-10-23

Initial release.

The following actions are available in this initial release:

  • Label - Specifies a location
  • Say - Replaces the dialog in the current state
  • Add - Appends text to the end of the dialog in the current state
  • Choice - Adds a choice and all following choices to the current state
  • Pause - Pauses execution for a short amount of time
  • Jump - Modifies the stack so that execution will continue at the specified label
  • Call - Pushes a new stack frame onto the stack with the children nodes from the specified label
  • Return - Exits the current stack frame

You can also:

  • Bind methods to a Rumor's scope
  • Subscribe to events on each new node

For examples of how Rumor works, see the Examples/ folder.