summaryrefslogtreecommitdiff
path: root/doc/classes/Engine.xml
diff options
context:
space:
mode:
authorIbrahn Sahir <ibrahn.sahir@gmail.com>2018-05-16 05:54:22 +0100
committerIbrahn Sahir <ibrahn.sahir@gmail.com>2018-05-19 00:40:16 +0100
commit1433c2cbbb89df1edb0b727c9781481af5705f59 (patch)
tree275b605dc53f680129baf19e1b954feaf35b75a4 /doc/classes/Engine.xml
parentedc3e6b0daf4acfeb3565f0f799d304d945e5a0a (diff)
GDScript access to copyright, license, author and donor information.
Adds following functions to the Engine singleton: get_author_info - names of Godot authors get_copyright_info - detailed source copyright get_license_info get_donor_info - donor names get_license_info - full text of licenses used, indexed by license names get_license_text - the text of the Godot Expat license
Diffstat (limited to 'doc/classes/Engine.xml')
-rw-r--r--doc/classes/Engine.xml44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml
index cc2ae4e768..3273005395 100644
--- a/doc/classes/Engine.xml
+++ b/doc/classes/Engine.xml
@@ -11,6 +11,36 @@
<demos>
</demos>
<methods>
+ <method name="get_author_info" qualifiers="const">
+ <return type="Dictionary">
+ </return>
+ <description>
+ Returns engine author information in a Dictionary.
+
+ "lead_developers" - Array of Strings, lead developer names
+ "founders" - Array of Strings, founder names
+ "project_managers" - Array of Strings, project manager names
+ "developers" - Array of Strings, developer names
+ </description>
+ </method>
+ <method name="get_copyright_info" qualifiers="const">
+ <return type="Array">
+ </return>
+ <description>
+ Returns an Array of copyright information Dictionaries.
+
+ "name" - String, component name
+ "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component
+ </description>
+ </method>
+ <method name="get_donor_info" qualifiers="const">
+ <return type="Dictionary">
+ </return>
+ <description>
+ Returns a Dictionary of Arrays of donor names.
+ {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}
+ </description>
+ </method>
<method name="get_frames_drawn">
<return type="int">
</return>
@@ -25,6 +55,20 @@
Returns the frames per second of the running game.
</description>
</method>
+ <method name="get_license_info" qualifiers="const">
+ <return type="Dictionary">
+ </return>
+ <description>
+ Returns Dictionary of licenses used by Godot and included third party components.
+ </description>
+ </method>
+ <method name="get_license_text" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ Returns Godot license text.
+ </description>
+ </method>
<method name="get_main_loop" qualifiers="const">
<return type="MainLoop">
</return>