Click or drag to resize

ModScript Methods

The ModScript type exposes the following members.

Methods
  NameDescription
Public methodOnModLoaded
Event method triggered when the mod has been successfully loaded. Use this method for mod setup code, similar to Unity's Start method.
Public methodOnModUnload
Event method triggered just before the mod will be unloaded from the game. Use this method for mod cleanup code, similar to Unity's OnDestroy method. Note that you are not required to unload asset created by this mod as they will be cleaned up automatically. ///
Public methodOnModUpdate
Event method triggered when the mod will be updated. Typically will be the frame rate of the game however excessive time spent in mod methods may result in throttling of this method. Use this method for mod update code, similar to Unity'S Update method
Top
See Also