diff options
| author | MSC <m.schlack@protonmail.com> | 2016-08-05 05:29:23 -0500 |
|---|---|---|
| committer | Rémi Verschelde <remi@verschelde.fr> | 2016-08-05 12:29:23 +0200 |
| commit | 7b05b4c83c94b5c1bbdf5372328192d5ea9f4bea (patch) | |
| tree | b37ea6d330e3ed787f971f5a4b56e9f0fa48e1a4 /doc | |
| parent | 6ed5d48d0c01c551735121915eb006376269c380 (diff) | |
Some additions to the OS documentation (#6037)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index e4b2a2075b..7b7430ec13 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -22339,6 +22339,7 @@ <argument index="1" name="title" type="String" default=""Alert!""> </argument> <description> + Displays a modal dialog box utilizing the host OS. </description> </method> <method name="can_draw" qualifiers="const"> @@ -22352,6 +22353,7 @@ <return type="bool"> </return> <description> + Returns if the current host platform is using multiple threads. </description> </method> <method name="delay_msec" qualifiers="const"> @@ -22372,12 +22374,17 @@ <argument index="0" name="file" type="String"> </argument> <description> + Dumps the memory allocation ringlist to a file (only works in debug). + Entry format per line: "Address - Size - Description" </description> </method> <method name="dump_resources_to_file"> <argument index="0" name="file" type="String"> </argument> <description> + Dumps all used resources to file (only works in debug). + Entry format per line: "Resource Type : Resource Location" + At the end of the file is a statistic of all used Resource Types. </description> </method> <method name="execute"> @@ -22401,12 +22408,14 @@ <argument index="0" name="string" type="String"> </argument> <description> + Returns the scancode of the given string (e.g. "Escape") </description> </method> <method name="get_borderless_window" qualifiers="const"> <return type="bool"> </return> <description> + Returns true if the current window is borderless. </description> </method> <method name="get_clipboard" qualifiers="const"> @@ -22434,6 +22443,7 @@ <return type="String"> </return> <description> + Returns the value of the commandline argument "-level". </description> </method> <method name="get_data_dir" qualifiers="const"> @@ -22482,6 +22492,14 @@ <return type="Dictionary"> </return> <description> + Returns the current engine version information in a Dictionary. + + "major" - Holds the major version number as a String + "minor" - Holds the minor version number as a String + "patch" - Holds the patch version number as a String + "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String + "revision" - Holds the revision (e.g. "custom-build") as a String + "string" - major + minor + patch + status + revision in a single String </description> </method> <method name="get_environment" qualifiers="const"> @@ -22534,6 +22552,8 @@ <return type="String"> </return> <description> + Returns the current latin keyboard variant as a String. + Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO" or "ERROR" </description> </method> <method name="get_locale" qualifiers="const"> @@ -22554,6 +22574,7 @@ <return type="String"> </return> <description> + Returns the model name of the current device. </description> </method> <method name="get_name" qualifiers="const"> @@ -22583,6 +22604,7 @@ <argument index="0" name="code" type="int"> </argument> <description> + Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). </description> </method> <method name="get_screen_count" qualifiers="const"> |