Returns the width and height (respectively) of the game window in pixels.
Returns the return value of the mod with the given name.
If you don't return anything in your init.lua
file, this function will return nil
. This will often look like return MyMod:new()
at the end of your file. See the Lua documentation for info about how classes can be implemented in Lua.
Returns the singleton for the given type name if it exists, otherwisenil
.
A singleton is the sole instance of a type, often used for global operations.
Returns the current CET build's commit hash.
Returns whether the specified .archive
file is present in the archive/pc/mod
folder
This technique can be used to detect whether your Redscript mod is present, from CET side. It can be useful if you are writing a mod with both languages for some reason.
You can declare a static method without a body. It will do nothing:
You can now test whether this method is defined from CET side using this:
You can call IsRedscriptDetected()
and it will return true
when your Redscript method is detected (meaning your Redscript mod is loaded) or false otherwise.
Don't forget to change NameOfYourMod
in both cases.