Modding Basics

Helfer V4 Release 10

After you have set everything up you can now make your actual mod.

Update Intervall

  • The _UpdateInterval variable specifies how often the main function should be called in milliseconds.

  • If the _UpdateInterval variable is not set, it is automatically set to 1000 ms.

  • The _UpdateInterval variable cannot be changed during runtime.


Example:

Custom Inputs

  • Inputs are defined in the _Inputs array.

    • The _Inputs array is a 2 dimensional array.

    • The dimensions are: [number of inputs, 5]

  • Each input must have a unique name, otherwise there may be problems loading.

  • You can have either a number (Type = num) or a text (Type = txt) as input.

  • It is also possible to add one or more headings (Type = hed).

  • If you want to access the _Inputs array from the Main function you have to make is static.

  • Inputs are saved automatically and independently of layouts.

Fields definitions:

1 2 3 4 5
{"Value", "Type", "Name", "min(If Number)", "max(If Number)"}


  • The first value of the input array is the value from the input.

    • The field gives you the user's input

    • The standard value can be set here

    • If you update this value in the code, the user input will not be updated!

  • The second value is the type

    • There are three types:

      • Text (Type="txt")

      • Number (Type="num")

      • Number Slider (Type="sld")

      • Bool (Type="bol")

      • Header (Type="hed")

    • If the type is not one of the above, the Input will be ignored

  • The third value is the Name

    • As already mentioned above, the name must be unique as it can cause problems

    • The name will be displayed next to the input field

  • The fourth and fifth values are only for the number input

    • The fourth value specifies the maximum value of the input

    • The fifth value specifies the minimum value of the input


Example: