summaryrefslogtreecommitdiffstats
path: root/source/rainerscript/functions/rs-cnum.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--source/rainerscript/functions/rs-cnum.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/source/rainerscript/functions/rs-cnum.rst b/source/rainerscript/functions/rs-cnum.rst
new file mode 100644
index 0000000..055a343
--- /dev/null
+++ b/source/rainerscript/functions/rs-cnum.rst
@@ -0,0 +1,36 @@
+******
+cnum()
+******
+
+Purpose
+=======
+
+cnum(expr)
+
+Converts expr to a number (integer).
+
+.. note::
+
+ If the expression does not contain a numerical value, the following
+ rule applies: the best match as the number is returned. For example
+ "1x234" will return the number 1 and "Test123" will return 0. Zero is
+ always returned if the there is no number at the start of the string.
+ This also is the case for empty strings.
+
+
+Example
+=======
+
+
+
+.. code-block:: none
+
+ cnum(3+2);
+
+produces
+
+.. code-block:: none
+
+ 5
+
+