Differences

This shows you the differences between two versions of the page.

--- mod-management-functions [2020/12/14 09:49] – [registerPrefabComponent] maxime
+++ mod-management-functions [2021/12/09 10:45] – maxime
@@ Line 7: / Line 7: @@
 Loads and runs a Lua script
-Returns ''true'' if the file is inside the mod directory and exists, ''false'' otherwise
+Returns the file's return values
-''boolean **myMod:dofile**(//scriptPath// [, //args...//])''
+''[...] **myMod:dofile**(//scriptPath// [, //args...//])''
 ^ Name ^ Type ^ Description ^
@@ Line 17: / Line 17: @@
 ----
-===== register =====
+===== registerAsset =====
+Deprecated name: ''register''
 Register a new game asset
-''void **myMod:register**(//assetData//)''
+''void **myMod:registerAsset**(//assetData//)''
 ^ Name ^ Type ^ Description ^
@@ Line 34: / Line 36: @@
     ...
 }
-myMod:register(assetData)
+myMod:registerAsset(assetData)
 </code>
 ----
-===== override =====
+===== overrideAsset =====
+Deprecated name: ''override''
 Override an existing game asset (see [[:asset-override|Asset Override]] for a complete explanation)
-''void **myMod:override**(//assetData//)''
+''void **myMod:overrideAsset**(//assetData//)''
 ^ Name ^ Type ^ Description ^
-| //''assetData''// | ''table'' | the data defining the overridden asset. The table must contain at least the existing asset's type (''Id'', see [assets|Assets]] for the complete list) |
+| //''assetData''// | ''table'' | the data defining the overridden asset. The table must contain at least the existing asset's type (''Id'', see [[assets|Assets]] for the complete list) |
 ==== Example ====
@@ Line 55: / Line 59: @@
     ...
 }
-myMod:override(assetData)
+myMod:overrideAsset(assetData)
 </code>
@@ Line 64: / Line 68: @@
 Assign an asset ID to an asset in the mod's directory
-''void **myMod:registerAssetId**(//assetPath//, //assetId//)''
+''void **myMod:registerAssetId**(//assetPath//, //assetId// [, //assetType//])''
 ^ Name ^ Type ^ Description ^
 | //''assetPath''// | ''string'' | the path to the asset |
 | //''assetId''// | ''string'' | the ID to assign to the asset |
+| //''assetType''// | ''string'' | optional, type of the asset |
 ----