CORE/docs/references/moam.gd.md
JeremyStarTM ab5b3ade52 Backup before I nuke the project
- Rewrote mkdevprj/rmdevprj in Makefile
- Add MOAM modloader
- Add core.exception()
- Add protection mode
- Rewrote module initialization
- Add experimental markdown parser
- Many more very small changes
2023-08-07 14:49:12 +02:00

61 lines
1.9 KiB
Markdown

---
hide:
- navigation
---
# Mother Of All Mods [Modloader] (core.moam)
Loads and executes modifications.
## Methods
### load_mods()
- returns `Array`
- description `Loads all modifications and returns all encountered errors as a a collection of strings`
### load_mod()
- returns `String` (if **not** `""` some error occured)
- description `Loads and executes a modification`
- argument `mod_name`
- type `String`
- mandatory `yes`
- description `The modification name to use`
### unload_mods()
- returns `void`
- description `Unloads all loaded modifications`
### unload_mod()
- returns `void`
- description `Unloads a modification`
- argument `mod_name`
- type `String`
- mandatory `yes`
- description `The modification name to use`
### get_list()
- returns `Array`
- description `Returns a list of all loaded modification names`
### get_info()
- returns `Dictionary` (if a error occured the dict will contain a `error` key)
- description `Returns information about a modification`
- argument `mod_name`
- type `String`
- mandatory `yes`
- description `The modification name to use`
## Internal variables
Do not touch or you will cause breakage.
### modlist
- type `Array`
- default value `[]`
- description `All loaded modification (names)`
### config_loadpath
- type `String`
- default value `null`
- description `The mods directory all modifications are loaded from`
### config_wanted_name
- type `String`
- default value `null`
- description `Used for the modinfo filename. If set to "testapp" it will search for "testapp.coremod" files`
### config_wanted_version
- type `String`
- default value `null`
- description `The application or game version. Modifications will not load if they don't support the specified version`
### config_wanted_api
- type `String`
- default value `null`
- description `The application or game api version. Modifications will not load if they don't support the specified api version.`