summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-02-17 13:38:52 +0100
committerRémi Verschelde <rverschelde@gmail.com>2019-02-17 13:38:52 +0100
commit2e6501d879105acd7355393838dc2930d533b768 (patch)
tree54503742d17915e7e16c9c7993984e3e6a742cb6 /doc
parent623f7b64ae7ab075fe9cc7f5b7b2c777e774f81d (diff)
Add hex-encoded version number to Engine singleton for easy comparisons
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Engine.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml
index f921b76b21..b8808b8b53 100644
--- a/doc/classes/Engine.xml
+++ b/doc/classes/Engine.xml
@@ -90,9 +90,17 @@
"major" - Holds the major version number as an int
"minor" - Holds the minor version number as an int
"patch" - Holds the patch version number as an int
+ "hex" - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below)
"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
"build" - Holds the build name (e.g. "custom-build") as a String
"string" - major + minor + patch + status + build in a single String
+ The "hex" value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code:
+ [codeblock]
+ if Engine.get_version_info().hex >= 0x030200:
+ # do things specific to version 3.2 or later
+ else:
+ # do things specific to versions before 3.2
+ [/codeblock]
</description>
</method>
<method name="has_singleton" qualifiers="const">