Skip to content

Commit

Permalink
docs: comprehensive configuration tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
samtupy committed Jun 15, 2024
1 parent 833bde3 commit b31f949
Show file tree
Hide file tree
Showing 2 changed files with 185 additions and 3 deletions.
4 changes: 1 addition & 3 deletions doc/src/manual/-BGT Upgrading+.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@ our goal is to make the transission as seemless as possible from BGT to NVGT, bu

* Always `#include "bgt_compat.nvgt"` as this includes a lot of aliases to other functions. Using built-in functions may improve performance so this is more or less a stop-gap to get you up and running quickly; however if you wish for your code to just run, bgt_compat will certainly be of use.
* When refering to an array's length, pass length as a method call and not as a property. ,For example, you would use `array.length();` rather than `a.length;`.
* The `sound::stream()` method does exist in NVGT, but it's simply an alias to `sound::load()`. For this reason it is recommended that you change all your `stream()` calls to `load()` instead.
* The `sound::stream()` method does exist in NVGT, but it's simply an alias to `sound::load()`. For this reason it is recommended that you change all your `stream()` calls to `load()` instead. The load function performs an efficient combination of streaming and preloading by default.
* load() contains a second optional argument to pass a pack file. set_sound_storage() is no longer used for the moment. However, you can set sound_pool.pack_file to a pack handle to get a similar effect.
* The Angelscript syntax for naming arguments in function calls has changed. func(arg, arg, arg=value); must now become func(arg, arg, arg:value);
* Take care to check any method calls using the tts_voice object as a few methods such as set_voice have changed from their BGT counterparts.
* When splitting a string, matching against \r\n is advised as BGT handles this differently. This will result in not having spurious line breaks at the ends of split text.
* The settings object has been crafted as a ghost object. That is, it will not actually load or write any data from the registry. If you use the registry, consider using a data or ini file instead.
* The joystick object is also a ghost object and does not currently function.
* The calendar object has been renamed to datetime.
* There is a type called `var` in the engine now, so you may need to be careful if your project contains any variables named var.
Loading

0 comments on commit b31f949

Please sign in to comment.