From 1f9c83ef453741b7029b5706c7cd52edc7ce9039 Mon Sep 17 00:00:00 2001
From: Emistry Haoyan <equinox1991@gmail.com>
Date: Tue, 14 May 2019 23:44:20 +0800
Subject: Add *cap_value script command
- add `cap_value(value, min, max)` script command.
- avoid the ugly nested `min()` and `max()` combo if needed.
---
doc/script_commands.txt | 12 ++++++++++++
1 file changed, 12 insertions(+)
(limited to 'doc')
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 516454365..2cbeff37b 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -8536,6 +8536,18 @@ Example:
---------------------------------------
+*cap_value(<number>, <min>, <max>)
+
+Returns the number but capped between <min> and <max>.
+
+Example:
+ // capped between 0 ~ 100
+ .@value = cap_value(10, 0, 100); // .@value will be equal to 10
+ .@value = cap_value(1000, 0, 100); // .@value will be equal to 100
+ .@value = cap_value(-10, 3, 100); // .@value will be equal to 3
+
+---------------------------------------
+
*md5("<string>")
Returns the md5 checksum of a number or string.
--
cgit v1.2.3-70-g09d2