User Tools

Site Tools


foundation-library-functions

Differences

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

Link to this comparison view

foundation-library-functions [2020/05/22 12:18] (current)
maxime created
Line 1: Line 1:
 +====== Foundation library functions ======
  
 +===== createMod =====
 +
 +Creates and returns a new mod
 +
 +''​void **foundation.createMod**()''​
 +
 +----
 +
 +===== isModEnabled =====
 +
 +Checks if a mod is enabled
 +
 +Returns ''​true''​ if the mod is found and it is enabled, ''​false''​ otherwise
 +
 +''​boolean **foundation.isModEnabled**(//​modId//​)''​
 +
 +^ Name ^ Type ^ Description ^
 +| //''​modId''//​ | ''​string''​ | the ID of the target mod. This ID is automatically generated and can be found in the mod's folder, in the file ''​generated_ids.lua'',​ in the field ''​ModId''​ |
 +
 +----
 +
 +===== getModVersion =====
 +
 +Retrieves the version of a mod
 +
 +Returns the version as set by the mod's creator. This version can, or not, respect any versioning standard.
 +
 +''​string **foundation.getModVersion**(//​modId//​)''​
 +
 +^ Name ^ Type ^ Description ^
 +| //''​modId''//​ | ''​string''​ | the ID of the target mod. This ID is automatically generated and can be found in the mod's folder, in the file ''​generated_ids.lua'',​ in the field ''​ModId''​ |
 +
 +----
 +
 +===== getGameVersion =====
 +
 +Retrieves the game's version
 +
 +Returns a string corresponding to the version of the game
 +
 +''​string **foundation.getGameVersion**()''​
foundation-library-functions.txt ยท Last modified: 2020/05/22 12:18 by maxime