summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-06-21 14:21:07 -0400
committergumi <mekolat@users.noreply.github.com>2017-06-21 14:21:07 -0400
commitf9ddfcc6e373ab8245ae6fb70737a284c55b3203 (patch)
tree23d66af9cd1acd272787f18343a4322e2b81d26f
parent8d3220163ef4bbdf9a94728f35971bccf6508439 (diff)
downloadhercules-f9ddfcc6e373ab8245ae6fb70737a284c55b3203.tar.gz
hercules-f9ddfcc6e373ab8245ae6fb70737a284c55b3203.tar.bz2
hercules-f9ddfcc6e373ab8245ae6fb70737a284c55b3203.tar.xz
hercules-f9ddfcc6e373ab8245ae6fb70737a284c55b3203.zip
add documentation for getdatatype()
-rw-r--r--doc/script_commands.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 34089f767..8b3cebbc2 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -8334,6 +8334,30 @@ Example:
---------------------------------------
+*getdatatype(<argument>)
+
+This command returns the raw type of the given <argument>. Unlike
+isstr, this command does not evaluate the argument. The returned type
+is bitmasked.
+
+types include:
+
+ DATATYPE_NIL
+ DATATYPE_STR
+ DATATYPE_INT
+ DATATYPE_CONST
+ DATATYPE_PARAM
+ DATATYPE_VAR
+ DATATYPE_LABEL
+
+Example:
+
+ getdatatype() // DATATYPE_NIL
+ getdatatype("foo") // DATATYPE_STR
+ getdatatype(@foo$) // (DATATYPE_VAR | DATATYPE_STR)
+
+---------------------------------------
+
*charisalpha("<string>", <position>)
This function will return true if the character number Position in the given