mirror of
https://github.com/godotengine/godot.git
synced 2026-01-03 18:11:19 +03:00
Doc: Add "required" qualifier to methods
This commit is contained in:
Haoyu Qiu
@@ -7,17 +7,17 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_can_instantiate" qualifiers="virtual const">
|
||||
<method name="_can_instantiate" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_editor_can_reload_from_file" qualifiers="virtual">
|
||||
<method name="_editor_can_reload_from_file" qualifiers="virtual required">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_base_script" qualifiers="virtual const">
|
||||
<method name="_get_base_script" qualifiers="virtual required const">
|
||||
<return type="Script" />
|
||||
<description>
|
||||
</description>
|
||||
@@ -27,60 +27,60 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_constants" qualifiers="virtual const">
|
||||
<method name="_get_constants" qualifiers="virtual required const">
|
||||
<return type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_doc_class_name" qualifiers="virtual const">
|
||||
<method name="_get_doc_class_name" qualifiers="virtual required const">
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_documentation" qualifiers="virtual const">
|
||||
<method name="_get_documentation" qualifiers="virtual required const">
|
||||
<return type="Dictionary[]" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_global_name" qualifiers="virtual const">
|
||||
<method name="_get_global_name" qualifiers="virtual required const">
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_instance_base_type" qualifiers="virtual const">
|
||||
<method name="_get_instance_base_type" qualifiers="virtual required const">
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_language" qualifiers="virtual const">
|
||||
<method name="_get_language" qualifiers="virtual required const">
|
||||
<return type="ScriptLanguage" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_member_line" qualifiers="virtual const">
|
||||
<method name="_get_member_line" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<param index="0" name="member" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_members" qualifiers="virtual const">
|
||||
<method name="_get_members" qualifiers="virtual required const">
|
||||
<return type="StringName[]" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_method_info" qualifiers="virtual const">
|
||||
<method name="_get_method_info" qualifiers="virtual required const">
|
||||
<return type="Dictionary" />
|
||||
<param index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_property_default_value" qualifiers="virtual const">
|
||||
<method name="_get_property_default_value" qualifiers="virtual required const">
|
||||
<return type="Variant" />
|
||||
<param index="0" name="property" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_rpc_config" qualifiers="virtual const">
|
||||
<method name="_get_rpc_config" qualifiers="virtual required const">
|
||||
<return type="Variant" />
|
||||
<description>
|
||||
</description>
|
||||
@@ -92,68 +92,68 @@
|
||||
Return the expected argument count for the given [param method], or [code]null[/code] if it can't be determined (which will then fall back to the default behavior).
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_script_method_list" qualifiers="virtual const">
|
||||
<method name="_get_script_method_list" qualifiers="virtual required const">
|
||||
<return type="Dictionary[]" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_script_property_list" qualifiers="virtual const">
|
||||
<method name="_get_script_property_list" qualifiers="virtual required const">
|
||||
<return type="Dictionary[]" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_script_signal_list" qualifiers="virtual const">
|
||||
<method name="_get_script_signal_list" qualifiers="virtual required const">
|
||||
<return type="Dictionary[]" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_source_code" qualifiers="virtual const">
|
||||
<method name="_get_source_code" qualifiers="virtual required const">
|
||||
<return type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_method" qualifiers="virtual const">
|
||||
<method name="_has_method" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_property_default_value" qualifiers="virtual const">
|
||||
<method name="_has_property_default_value" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="property" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_script_signal" qualifiers="virtual const">
|
||||
<method name="_has_script_signal" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="signal" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_source_code" qualifiers="virtual const">
|
||||
<method name="_has_source_code" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_static_method" qualifiers="virtual const">
|
||||
<method name="_has_static_method" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_inherits_script" qualifiers="virtual const">
|
||||
<method name="_inherits_script" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="script" type="Script" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_instance_create" qualifiers="virtual const">
|
||||
<method name="_instance_create" qualifiers="virtual required const">
|
||||
<return type="void*" />
|
||||
<param index="0" name="for_object" type="Object" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_instance_has" qualifiers="virtual const">
|
||||
<method name="_instance_has" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<param index="0" name="object" type="Object" />
|
||||
<description>
|
||||
@@ -165,17 +165,17 @@
|
||||
Returns [code]true[/code] if the script is an abstract script. Abstract scripts cannot be instantiated directly, instead other scripts should inherit them. Abstract scripts will be either unselectable or hidden in the Create New Node dialog (unselectable if there are non-abstract classes inheriting it, otherwise hidden).
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_placeholder_fallback_enabled" qualifiers="virtual const">
|
||||
<method name="_is_placeholder_fallback_enabled" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_tool" qualifiers="virtual const">
|
||||
<method name="_is_tool" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_valid" qualifiers="virtual const">
|
||||
<method name="_is_valid" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
@@ -186,25 +186,25 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_placeholder_instance_create" qualifiers="virtual const">
|
||||
<method name="_placeholder_instance_create" qualifiers="virtual required const">
|
||||
<return type="void*" />
|
||||
<param index="0" name="for_object" type="Object" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_reload" qualifiers="virtual">
|
||||
<method name="_reload" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="keep_state" type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_source_code" qualifiers="virtual">
|
||||
<method name="_set_source_code" qualifiers="virtual required">
|
||||
<return type="void" />
|
||||
<param index="0" name="code" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_update_exports" qualifiers="virtual">
|
||||
<method name="_update_exports" qualifiers="virtual required">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user