From cfd20d2657db0b129e10acbd8787eea017fa5cbd Mon Sep 17 00:00:00 2001 From: Haru Date: Sat, 16 May 2015 15:17:06 +0200 Subject: 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 --- doc/script_commands.txt | 31 ++++++++++--------------------- 1 file changed, 10 insertions(+), 21 deletions(-) (limited to 'doc') 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() - -Returns the number rounded down. - -Example: - .@i = floor(2.5); // .@i will be 2 - ---------------------------------------- - -*ceil() - -Returns the number rounded up. - -Example: - .@i = ceil(2.5); // .@i will be 3 - ---------------------------------------- - -*log() +*log10() 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); -- cgit v1.2.3-60-g2f50