Skip to content
Raymond Wu edited this page Apr 7, 2021 · 15 revisions

Welcome to the BattleRegeneration wiki!

For up-to-date formula definitions, see BattleRegen.xml from the mod's bin/Win64_Shipping_Client folder. For localization, see eng_module_strings.xml from ModuleData/Languages folder.

API definitions and localization keys are not always up-to-date.

How to Create A Formula

Some C# or Visual Basic knowledge is required. C# tutorial here. VB tutorial here.

Declare a class and derive it from Formula. Make sure to add using BattleRegen (if using C#) or Imports BattleRegen (if using VB) to the top of the mod file.

If defining the class in a standalone code file, it must have the suffix of .battleregen.cs (for C# code) or `.battleregen.vb (for VB code), and you need to put it inside the ModuleData folder of a mod. If defining the class as part of your compiled code, call Formula.AddFormula method with the type of the formula you have defined.

Clone this wiki locally