THE Dialogue Engine

THE VIDEOS SECTION FOR THIS ITEM IS STILL UNDER CONSTRUCTION

Please check back in soon...

v2.1

1. Minimum required version is now 2017.3
2. Updated code to C#6
3. Made the code compatible with the latest version of MBSCore
   1. Added the ability to do basic math on key values
   2. Updated CML to version 4 and updated the class names to go with it
   3. Added the MBSUtiliies class to the project. Please see the documentation for that to see what that adds to your project
   4. Added the MBSEvent class. Please see the documentation for that to see what that adds to your project
   5. Removed the custom UDEAEvent and UDEAEventHandler in favour of the updated MBSEvent and MBSEventHandler
4. Replaced the custom Exception definitions with the generic Exception
5. Simplified CMLGameKeys by making use of the updated features of CML4

v2.0.1

1. Fixed a compatibility issue with U5.5
2. Updated outdated Editor script to not show meaningless errors all the time
3. Fixed a bunch of errors in the demo dialogues
4. Rearranged some folders

v2.0

1. Added a change log
2. Added AutoContinueOnClick boolean to UDEA.
   Enable to continue the dialogue with a left click

   Disable to allow the UDEA to be used with NGUI/ UGUI / etc.

3. Added CurrentSprite property alongside CurrentAvatar property. You can now fetch a Sprite or a Texture2D
4. WhoIsSpeakingAvatar now first tries to load a Sprite and loads a Texture only if that fails
5. Removed the use of the ProcessKeys function to handle custom keys
6. Custom keys now directly calls any function you want. The first param of your key is the function name

   For example, a custom key “ChangeVolume BGSource 0.4” will send the params “BGSource” and “0.4” to a

   function called ChangeVolume

7. Custom keys can now have any number of parameters or none at all. If using parameters they will be passed

   as a single CMLData object so be sure to create your functions like this: public void FuncX(CMLData data)

8. Custom key’s parameters can now be prefixed with a descriptive name using the : seperator

   Example: [keys] ChangeVolume WhichItem:BGSource Volume:0.4 FadeSpeed:0.15, KeyWithNoParams

   Parameters without names are accessed in the order they are declared, ignoring named parameters before it

   Paramteres with names are accessed by name and can be converted to it’s relevant type

   Example:

   Using key "ChangeVolume BGSource, Volume: 0.4, 0.15" with function: FuncX(CMLData fields)
   
   string bgSource = fields.data[0]; <-- accessed via data array. First entry
   
   float volume = fields.Float("volume"); <-- accessed by name. Converted to type
   
   float fadespeed = float.Parse( fields.data[1] ); <-- second entry in data array. Value returned as string

9. Added UGUI display prefabs
10. Removed old OnGUI displays and prefabs
11. Now require that the dialogue be parented to a canvas, no longer simply run directly on random objects
12. Added BroadcastToSelf boolean to UDEA to allow you to send keys to a target object and to the display script sending it
13. Dialogue prefabs are now destroyed instead of disabled so there is now a difference in implementation
14. Removed “Parent” property from the UDEA class as it was just a duplicate of the public “parent” variable
15. Removed redundant OpenFile and StartDialogue methods
16. Changed CurrentIsChoice function to look at number of redirect values, rather than implicit “choice” value
17. Removed the need to add “choice=true” in dialogue scripts. This is now completely redundant
18. Made the OnSpeakStart, OnSpeakEnd, OnTypewriterModeUpdate and OnSelectionChange events local events, not static
19. Removed the legacy Actions HUD product from THE Dialogue Engine.
20. Fixed a bug with WhoIsSpeakingName if called after the dialogue contents were cleared

21. Added an Audio system to THE Dialogue Engine. Just drag the audio prefab onto an object, add some clips to it and you

    can now play audio right from your dialogue. Simply add the key “PlaySound track:trackname” where

    trackname is the name of a track you added to the prefab. Alternatively you can also use “PlaySound index:x”

    where x is the array index of a clip you added to the prefab.

    You can also add in “loop:true” or “loop:false” if you want. i.e. “PlaySound track:help loop:false”

22. Added a barking system. Use the same audio system and add the sentences you want the character to speak

    Simply tick the “random_barks” box and specify the min and max wait time between random barks. Primarily used

    to make guards say random stuff, in the demo I use it to play random electrical beeps and crackles on the

    damaged robot. Turn this barks system on or off during dialogues using “DisableRandomBarks” or “EnableRandomBarks”

23. For the sake of the Visual Novel prefab I also added a number of custom fields to THE Dialogue Engine dialogue format

    More info on these fields can be found in the relevant documentation

24. For the sake of the Visual Novel prefab I also added a number of custom functions that can be triggered either

    from the dialogue or from script directly. More info on these fields can be found in the relevant documentation

25. Added a lot more documentation to THE Dialogue Engine explaining it in far more detail than before

THE FAQ FOR THIS ITEM IS STILL UNDER CONSTRUCTION

Please check back in soon...