summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2015-05-16 15:17:06 +0200
committerHaru <haru@dotalux.com>2015-05-16 15:21:00 +0200
commitcfd20d2657db0b129e10acbd8787eea017fa5cbd (patch)
treee443300b6d23adcbb65167b4bc5aae4361aa73c6 /doc
parent363a856d052990d2de2e8486b856d43fc1b2a1b8 (diff)
downloadhercules-cfd20d2657db0b129e10acbd8787eea017fa5cbd.tar.gz
hercules-cfd20d2657db0b129e10acbd8787eea017fa5cbd.tar.bz2
hercules-cfd20d2657db0b129e10acbd8787eea017fa5cbd.tar.xz
hercules-cfd20d2657db0b129e10acbd8787eea017fa5cbd.zip
Follow-up to c9f845f4518fc3626d9bc2f7166db5a2ac620a57
- Removed documentation for floor and ceil. - Updated documentation for log10 to the new command's name. - Updated documentation for the math commands to mention that their return value is truncated to int. - Updated documentation for the distance() command to mention what type of distance it returns. Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt31
1 files changed, 10 insertions, 21 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 13b154560..0eb383c0a 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7646,31 +7646,14 @@ Example:
---------------------------------------
-
-*floor(<number>)
-
-Returns the number rounded down.
-
-Example:
- .@i = floor(2.5); // .@i will be 2
-
----------------------------------------
-
-*ceil(<number>)
-
-Returns the number rounded up.
-
-Example:
- .@i = ceil(2.5); // .@i will be 3
-
----------------------------------------
-
-*log(<number>)
+*log10(<number>)
Returns log base 10 of the number.
+Note: The value is truncated to integer.
+
Example:
- .@i = log(100); // .@i will be 2
+ .@i = log10(100); // .@i will be 2
---------------------------------------
@@ -7678,6 +7661,8 @@ Example:
Returns square-root of number.
+Note: The value is truncated to integer.
+
Example:
.@i = sqrt(25); // .@i will be 5
@@ -7687,6 +7672,10 @@ Example:
Returns distance between 2 points.
+Note: When Hercules is configured to use circular areas, the Euclidean distance
+is returned, otherwise the Chebyshev distance. The value is truncated to
+integer.
+
Example:
.@i = distance(100,200,101,202);