summaryrefslogtreecommitdiffstats
path: root/source/rainerscript/functions/index.rst
blob: a40e166a05fbcb2ee106c3cc1bf500b72b70a30c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
*********
Functions
*********

There are two types of RainerScript functions: built-ins and modules. Built-in
functions can always be called in the configuration. To use module functions,
you have to load the corresponding module first. To do this, add the following
line to your configuration:

::

	module(load="<name of module>")

If more than one function with the same name is present, the function of the
first module loaded will be used. Also, an error message stating this will be
generated. However, the configuration will not abort. Please note that built-in
functions will always be automatically loaded before any modules. Because of this, you
are unable to override any of the built-in functions, since their names are already
in use. The name of a function module starts with fm.


.. toctree::
   :glob:
   :maxdepth: 2

   idx_built-in_functions
   idx_module_functions