What are modules - Alexofp/BDCC GitHub Wiki

Module is a simple way to group related files together. Best example of that would be the portal panties module, it contains everything related to portal panties, the item itself, the quest and all the scenes/events in a single folder. That makes it way easier to manage the project without you having to jump between all the different folders while working on something specific.

Does that mean you can just remove a module and everything is gonna work like it was never there? Not really, most of the current modules depend on each other and it’s okay. Again, a module is just a folder to group things together.

extends Module

func _init():
	id = "SomeModule"
	author = "Rahi"
	
	items = [
		"res://Modules/SomeModule/TestItem.gd",
	]
	scenes = [
		"res://Modules/SomeModule/TestScene.gd",
	]
	events = [
		"res://Modules/SomeModule/TestSceneEvent.gd",
	]

The point of a module is to add new things into the game. New scenes, events, characters, species, etc. That’s how you extend the game without changing the current files.

Mods and modules are different things. Mod is a .zip archive that contains files. Mods can have modules in them. A single mod file can add several modules or none at all.

Modules can have flags. Flags are basically variables but they are saved/loaded for you automatically and can also be edited through a handy in-game flags editor. Very handy for debugging.

extends Module

func getFlags():
	return {
		"PlayerDidSomething": flag(FlagType.Bool),
		"SomethingElseHappened": flag(FlagType.Bool),
		"ThisIsANumberFlag": flag(FlagType.Number),
	}

func _init():
	id = "SomeModule"
	author = "Rahi"
	
	items = [
		"res://Modules/SomeModule/TestItem.gd",
	]
	scenes = [
		"res://Modules/SomeModule/TestScene.gd",
	]
	events = [
		"res://Modules/SomeModule/TestSceneEvent.gd",
	]

To use the flags you can use the setFlag, increaseFlag and getFlag functions.

setFlag("ModuleID.FlagID", newvalue)

increaseFlag("ModuleID.FlagID")

getFlag("ModuleID.FlagID", defaultValue)