start
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
start [2020/05/06 15:43] – [More info on:] maxime | start [2020/05/06 18:31] – maxime | ||
---|---|---|---|
Line 9: | Line 9: | ||
* ** [[changelog|Changelog]] ** | * ** [[changelog|Changelog]] ** | ||
* ** [[migration|Migration Notes]] ** | * ** [[migration|Migration Notes]] ** | ||
- | * ** [[guides|Guides]] ** | + | * ** [[guides|Community |
===== More info on: ===== | ===== More info on: ===== | ||
Line 15: | Line 15: | ||
* [[enumerations|Enumerations]] | * [[enumerations|Enumerations]] | ||
* [[example-mods|Example Mods]] | * [[example-mods|Example Mods]] | ||
+ | |||
+ | * [[mod-management-functions|Mod management functions]] | ||
+ | * [[mod-io-functions|Mod IO functions]] | ||
* [[dependencies|Mod Dependencies]] | * [[dependencies|Mod Dependencies]] | ||
Line 21: | Line 24: | ||
* [[building-asset-processor|Building asset processor]] | * [[building-asset-processor|Building asset processor]] | ||
* [[level-of-detail|Level Of Detail (LOD)]] | * [[level-of-detail|Level Of Detail (LOD)]] | ||
- | |||
- | * [[logs|Mod individual log file]] | ||
- | * [[mod-functions: | ||
* [[workplaces|Create workplaces]] | * [[workplaces|Create workplaces]] | ||
Line 57: | Line 57: | ||
In order to include another LUA file, you can call the '' | In order to include another LUA file, you can call the '' | ||
- | <code lua> | + | < |
myMod: | myMod: | ||
</ | </ | ||
This will execute the script '' | This will execute the script '' | ||
- | <file lua anotherscript.lua> | + | <code lua anotherscript.lua> |
local myMod = ... -- retrieve arguments passed to the script | local myMod = ... -- retrieve arguments passed to the script | ||
-- do stuff with myMod | -- do stuff with myMod | ||
-- ... | -- ... | ||
- | </file> | + | </code> |
In addition, you can pass any number of variable to the called script: | In addition, you can pass any number of variable to the called script: | ||
- | <code lua> | + | < |
myMod: | myMod: | ||
</ | </ | ||
- | <file lua anotherscript.lua> | + | <code lua anotherscript.lua> |
local myMod, anInteger, aString, anArray = ... -- retrieve arguments passed to the script | local myMod, anInteger, aString, anArray = ... -- retrieve arguments passed to the script | ||
- | </file> | + | </code> |
===== Enabling / Disabling a mod ===== | ===== Enabling / Disabling a mod ===== | ||
Line 85: | Line 85: | ||
If you want to fully ignore a mod, you can either remove it from your mods folder, or rename the '' | If you want to fully ignore a mod, you can either remove it from your mods folder, or rename the '' | ||
===== Logging / Debugging ===== | ===== Logging / Debugging ===== | ||
+ | |||
+ | ==== Log ==== | ||
You can log your own logs into foundation log file: | You can log your own logs into foundation log file: | ||
+ | |||
<code lua> | <code lua> | ||
- | myMod: | + | myMod: |
- | myMod: | + | myMod: |
- | myMod: | + | myMod: |
</ | </ | ||
- | You can also open a blocking message box for debugging purpose: | + | In order to isolate mods related logs, Foundation will log most of mod related information in a specific log file located in '' |
+ | |||
+ | However, keep in mind that a mod can interact with the game in various indirect way, and some valuable information could still be hidden in the global game log in '' | ||
+ | |||
+ | ==== Message box ==== | ||
+ | |||
+ | You can also open a blocking message box for debugging purpose. This function is recommended for mod development only. | ||
<code lua> | <code lua> | ||
myMod: | myMod: | ||
</ | </ | ||
+ | |||
+ | For this function to work, the user must manually set the field '' | ||
===== What is this generated_ids.lua file? ===== | ===== What is this generated_ids.lua file? ===== |
start.txt · Last modified: 2022/03/30 10:53 by maxime