Submodules

Note that this isn't an actual class you can use to create submodules but merely conventions that each submodule follows.

Summary

Type	Function
Function	boolean Init(ModReference Mod, string ParentDirectory)
Field	table Enum
Field	string _VERSION
Field	int _VERSION_NUM

Methods

Init()

boolean Init(ModReference Mod, string ParentDirectory)

Initializes the submodule. This is automatically called by the parent module when it initializes. This functionality is exposed for those who are not using the main module, and otherwise should not be used.

Fields

Enum

table Enum

Returns a table of custom enumerators related to the submodule. If there are no enumeratorss for the submodule, this will return an empty table.

Example

local SubmoduleName = IsaacHelper.GetModule("NameOfSubmodule")
print(SubmoduleName.Enum.Foo.BAR) -- "BarValue"
print(SubmoduleName.Enum.Foo.BAZ) -- "BazValue

_VERSION

string _VERSION

Returns the version number.

Example

print(SubmoduleName._VERSION) -- "v1.0.0"

_VERSION_NUM

int _VERSION_NUM

Returns the file iteration. If you had the 30th update to the file, this would be 30.

Example

print(SubmoduleName._VERSION_NUM) -- 1