Version 1.3.1

[1.3.1] - 2021-12-05

New Contributors

• @Cheemsandfriends made their first contribution in #75

Added

• All compile defines can now also be edited at runtime.
  • For example, you can enable Debug logging in code by using PolymodConfig.debug = true;
  • If you use these to set asset library locations, etc., be sure to set them before instantiating any classes which utilize script files.
• Added a config option to customize the mod append folder.
  • Modify this option by adding POLYMOD_APPEND_FOLDER as a compile define, or by setting PolymodConfig.appendFolder in your code.
  • Defaults to _append for backwards compatibility.
• Added a config option to customize the mod merge folder.
  • Modify this option by adding POLYMOD_MERGE_FOLDER as a compile define, or by setting PolymodConfig.mergeFolder in your code.
  • Defaults to _merge for backwards compatibility.
• Added a config option to customize the mod metadata file.
  • Modify this option by adding POLYMOD_MOD_METADATA_FILE as a compile define, or by setting PolymodConfig.modMetadataFile in your code.
  • Defaults to _polymod_meta.json for backwards compatibility.
• Added a config option to customize the mod icon file.
  • Modify this option by adding POLYMOD_MOD_ICON_FILE as a compile define, or by setting PolymodConfig.modIconFile in your code.
  • Defaults to _polymod_icon.png for backwards compatibility.
• Added a config option to customize the mod pack definition file.
  • Modify this option by adding POLYMOD_MOD_PACK_FILE as a compile define, or by setting PolymodConfig.modPackFile in your code.
  • Defaults to _polymod_pack.txt for backwards compatibility.
• Added a config option to customize the ignore list for Polymod mod files.
  • Modify this option by adding POLYMOD_MOD_IGNORE as a compile define (use a comma separated list), or by setting PolymodConfig.modIgnoreFiles in your code (use an Array<String>).
  • Defaults to LICENSE.txt,ASSET_LICENSE.txt,CODE_LICENSE.txt for backwards compatibility.
• Added optional as an @:hscript parameter.
  • This suppresses the error thrown when a script file is missing.

Changed

• Missing scripts are now handled gracefully rather than throwing an unhandled missing asset exception.
  • Added a debug print call when the script is missing but optional is set to true.

Fixed

• Fixed a bug where scripted function that define a pathName function fail to retrieve the script.
• Fixed compilation errors when using the HEAPS backend.
  • The HEAPS sample now compiles and runs without errors.
• Fixed a deprecation warning in the CSV.hx file.

Version 1.3.0

[1.3.0] - 2021-11-18

This release marks the transition to Eric Myllyoja as the lead maintainer for the repository.
This release is backwards compatible with 1.0.0 as no breaking changes have been made.

Added

• Added the NodeFileSystem class and OpenFLWithNodeBackend, for use with projects built in HTML5 for use with Electron.
  • Provided by TamarCurry.
• The @:hscript annotation can now be defined on classes and interfaces.
  • Defining a @:hscript annotation on a class or interface will add the constants provided to them to the context of any script functions of any of that class's children.
    • For example, @:hscript(Std, Math) on a class will allow any of that class's script functions to access Std and Math from the context as though they had defined them, without having to manually define these values for each individual function.
  • These values are parsed recursively, so any superclass, supersuperclass, interfaces of those classes, etc. will also be added to the context.
  • Updated the openfl_hscript sample to demonstrate this new syntax.
• The @:hscript annotation can now be defined as a parameter object.
  • This allows for additional types of configuration to be passed, aside from the script context.
  • Parameter objects can now be passed when using @:hscript on a class or interface.
    • Parameters are defined recursively, and values defined on a superclass or interface will be overridden by child classes.
    • The exception is the context parameter, which merges the provided contexts together.
  • If an identifier is provided in the annotation on a parent class or interface, the identifier need not necessarily be defined in the upper context.
    • For example, an interface can require that the variable scriptPath be included in the context or used as the script path name, without defining that variable itself, as long as any implementing classes that include a script function define that variable.
  • Updated the openfl_hscript sample to demonstrate this new syntax.
• Added context as an @:hscript parameter.
  • This achieves the existing functionality of providing constants to the script context.
  • Example: @:hscript({context: [Std, Math]})
• Added cancellable as an @:hscript parameter.
  • This allows for a script to be cancelled by the user. Defaults to false.
    • A new function cancel() is added to the context, which can be used to cancel the execution of the rest of the provided script body.
    • For example, you can add @:hscript({cancellable: true}) to allow users to cancel an event before you perform an action.
  • Example: @:hscript({context: [Std, Math], cancellable: true})
• Added pathName as an @:hscript parameter.
  • This allows for a script to specify the specific pathname to access.
    • This ignores the POLYMOD_ROOT_PATH and POLYMOD_USE_NAMESPACE settings.
    • The value of POLYMOD_SCRIPT_EXT is still appended to the final path.
  • Example: @:hscript({context: [Std, Math], pathName: "assets/scripts/initBee"})
• The pathName parameter can now use an identifier. This allows for the pathname to be defined dynamically by the object.
  • If a constant is provided, the value is used as the pathname.
    • Example: @:hscript({context: [Std, Math], pathName: "assets/scripts/initBee"})
  • If an identifier is provided, the value of that identifier is accessed at the time the function is called.
    • Example: @:hscript({context: [Std, Math], pathName: getScriptName})
    • If the resulting value is a string constant, that value is used as the path.
    • If the resulting value is a Function, it will be called and the return value will be used as the path.
• Added runBefore as an @:hscript parameter.
  • This allows for a script's function body to be called before the script, rather than after. Defaults to false.
  • Incompatible with the cancellable parameter.
  • Example: @:hscript({context: [Std, Math], runBefore: true})

Fixed

• Fixed a bug where defining @:hscript annotations on a parent class or interface would not pass the values down to the child function.

Version 1.2

[1.2.0] - 2021-11-04

Added

• Added several new compile defines to change the behavior of Polymod
  • POLYMOD_ROOT_PATH: Defines the base path from which scripts should be accessed.
  • POLYMOD_USE_NAMESPACE: If true, scripts are located in a folder based on the classpath.
    • For example, the script com.polymod.test#init will be located at /data/com/polymod/test/init.txt.
  • POLYMOD_SCRIPT_EXT: Defines the file extension used by all Polymod scripts.
    • This defaults to .txt for backwards compatibility, but should be changed to .hscript to improve integration with IDEs.
  • POLYMOD_SCRIPT_LIBRARY: Defines the asset library used by all Polymod scripts.
    • This defaults to default, which should be fine for Lime projects which only utilize the default asset library.
  • Set these values using either of the following methods:
    • For Haxe projects, add something like -D POLYMOD_SCRIPT_EXT=.hscript to your Haxe compiler arguments or hxml.
    • For Lime projects, add something like <haxedef name="POLYMOD_SCRIPT_EXT" value=".hscript" /> to your project.xml.
• Added the new variable script_variables, accessible after the execution of a scripted function.
  • Similar to script_result, which provides the return value of the script, and script_error, which outputs the error provided by the script, script_variables provides access to the named variables created by the script's local scope.
  • One use case for this is to allow a single script to define several named functions, which can be retrieved and stored to use later.

Version 1.1

[1.1.0] - 2021-09-25

New Contributors

• @mastereric made their first contribution in #34

Added

• Added several new informational error codes to onError:
  • MOD_LOAD_PREPARE: Called when Polymod is about to load a given mod.
  • MOD_LOAD_DONE: Called when Polymod has successfully finished loading a given mod. Useful for logging.
  • MOD_LOAD_FAIL: Called when Polymod has failed to load a given mod.
• Fully abstracted the file system and made it a parameter, similar to IBackend.
  • This allows users to implement and utilize their own custom file system class.
  • Example: Polymod.init({customFileSystem: CustomFileSystem}) given a class CustomFileSystem which implements IFileSystem.
• Added several video file types to the list of default file extensions.
  • Added .mov, .mp4, .avi, .mkv, and .webm.

Fixed

• Performed HaxeFormatter cleanup on all source files.
• Fixed a crash when old projects which used multiple asset libraries were not specifying frameworkParams.
  • This fix is required for users attempting to build Friday Night Funkin' or derivatives.

Version 1.0

[1.0.0] - 2021-09-15

The repository as it existed on 2020-09-15.

Added

• All basic functionality.

Changed

• Fixed support for Lime projects utilizing multiple asset libraries.

Known Issues

• A crash may occur when old projects (which do not specify frameworkParams.assetLibraryPaths) are run in this version.