godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Script.xml

117 lines
3.5 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="Script" inherits="Resource" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
A class stored as a resource.
</brief_description>
<description>
Fixed typo in docs for Script and GDScript classes ("exends" -> "extends")
2019-11-30 18:15:06 +00:00
A class stored as a resource. A script extends the functionality of all objects that instance it.
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
doc: Use HTTPS for docs.godotengine.org and point to latest branch Fixes #23509.
2018-11-05 07:46:27 +00:00
<link>https://docs.godotengine.org/en/latest/getting_started/step_by_step/scripting.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="can_instance" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns [code]true[/code] if the script can be instanced.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source
2017-12-20 16:16:02 +00:00
<method name="get_base_script" qualifiers="const">
<return type="Script">
</return>
<description>
Docs update for several classes Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar, ScrollContainer and SplitContainer
2018-04-17 14:18:57 +00:00
Returns the script directly inherited by this script.
doc: Sync classref with current source
2017-12-20 16:16:02 +00:00
</description>
</method>
<method name="get_instance_base_type" qualifiers="const">
<return type="String">
</return>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns the script's base type.
doc: Sync classref with current source
2017-12-20 16:16:02 +00:00
</description>
</method>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
<method name="get_property_default_value">
<return type="Variant">
</return>
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</method>
<method name="get_script_constant_map">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_script_method_list">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_script_property_list">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_script_signal_list">
<return type="Array">
</return>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="has_script_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="signal_name" type="String">
</argument>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_source_code" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns [code]true[/code] if the script contains non-empty source code.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="instance_has" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="base_object" type="Object">
</argument>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_tool" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="reload">
<return type="int" enum="Error">
</return>
<argument index="0" name="keep_state" type="bool" default="false">
</argument>
<description>
Reloads the script's class implementation. Returns an error code.
</description>
</method>
</methods>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
<member name="source_code" type="String" setter="set_source_code" getter="get_source_code">
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
</class>