Skip to content

README.md

Latest commit

 

History

History
63 lines (41 loc) · 1.36 KB

README.md

File metadata and controls

63 lines (41 loc) · 1.36 KB
Raw

HeapsMod

HeapsMod is a modding framework designed specifically for the Heaps game engine.

Installation

  • Run haxelib git heapsmod https://github.com/realvirtu/heapsmod.
  • Add -lib heapsmod to your hxml.

Usage

import heapsmod.HeapsMod;

HeapsMod.init();

// Enable mods
HeapsMod.enableMod("testmod");
HeapsMod.enableMod("testmod2");
HeapsMod.enableMod("testmod3");

// Same as above, but safer as dependency checks are done
for (meta in HeapsMod.scan())
{
    HeapsMod.enableMod(meta.mod);
}

Scripting (Optional)

Installation

  • Run haxelib install hxscript.
  • Add -lib hxscript to your hxml.

Usage

import heapsmod.script.HeapsScript;

// Should be done before loading mods

HeapsScript.setGlobalImport("package.Class");

HeapsScript.blacklistClass("dangerous.package.DangerousClass");
HeapsScript.blacklistPackage("dangerous.package");

// Should be done after loading mods

// Outputs all scripted classes
trace(HeapsScript.listClasses());

// Outputs all scripted classes that extend MyClass
trace(HeapsScript.listClasses(MyClass));

Scripted Classes

For classes to be extendable by scripted classes, they require a scripted version as done below. Although needed, scripted classes can still extend the original class.

class ScriptedDummyClass extends DummyClass implements hxscript.IScripted {}