godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

[DOCS] Classref additions and corrections

Browse Source
This commit is contained in:
Chris Bradfield
2018-09-01 11:07:51 -07:00
parent 6f9416b2b6
commit c049c8fbb9
6 changed files with 34 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/classes/Script.xml
View File

@@ -4,8 +4,8 @@
A class stored as a resource.
</brief_description>
<description>
A class stored as a resource. The script exends the functionality of all objects that instance it.
The 'new' method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
A class stored as a resource. A script exends the functionality of all objects that instance it.
The [code]new[/code] method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
</description>
<tutorials>
<link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scripting.html</link>
@@ -17,7 +17,7 @@
<return type="bool">
</return>
<description>
Returns true if the script can be instanced.
Returns [code]true[/code] if the script can be instanced.
</description>
</method>
<method name="get_base_script" qualifiers="const">
@@ -31,6 +31,7 @@
<return type="String">
</return>
<description>
Returns the script's base type.
</description>
</method>
<method name="has_script_signal" qualifiers="const">
@@ -39,14 +40,14 @@
<argument index="0" name="signal_name" type="String">
</argument>
<description>
Returns true if the script, or a base class, defines a signal with the given name.
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
</description>
</method>
<method name="has_source_code" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if the script contains non-empty source code.
Returns [code]true[/code] if the script contains non-empty source code.
</description>
</method>
<method name="instance_has" qualifiers="const">
@@ -55,14 +56,14 @@
<argument index="0" name="base_object" type="Object">
</argument>
<description>
Returns true if 'base_object' is an instance of this script.
Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.
</description>
</method>
<method name="is_tool" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if the script is a tool script. A tool script can run in the editor.
Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.
</description>
</method>
<method name="reload">
@@ -77,7 +78,7 @@
</methods>
<members>
<member name="source_code" type="String" setter="set_source_code" getter="get_source_code">
The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically.
The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.
</member>
</members>
<constants>