summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Engine.xml17
-rw-r--r--doc/classes/Range.xml2
-rw-r--r--doc/classes/ScriptExtension.xml173
-rw-r--r--doc/classes/ScriptLanguage.xml9
-rw-r--r--doc/classes/ScriptLanguageExtension.xml404
5 files changed, 604 insertions, 1 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml
index af4df321c1..506992e3af 100644
--- a/doc/classes/Engine.xml
+++ b/doc/classes/Engine.xml
@@ -94,6 +94,17 @@
[/codeblock]
</description>
</method>
+ <method name="get_script_language" qualifiers="const">
+ <return type="ScriptLanguage" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="get_script_language_count">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
<method name="get_singleton" qualifiers="const">
<return type="Object" />
<argument index="0" name="name" type="StringName" />
@@ -167,6 +178,12 @@
Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop.
</description>
</method>
+ <method name="register_script_language">
+ <return type="void" />
+ <argument index="0" name="language" type="ScriptLanguage" />
+ <description>
+ </description>
+ </method>
<method name="register_singleton">
<return type="void" />
<argument index="0" name="name" type="StringName" />
diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml
index 9743d969ca..df6efd155a 100644
--- a/doc/classes/Range.xml
+++ b/doc/classes/Range.xml
@@ -11,7 +11,7 @@
<methods>
<method name="_value_changed" qualifiers="virtual">
<return type="void" />
- <argument index="0" name="" type="float" />
+ <argument index="0" name="new_value" type="float" />
<description>
Called when the [Range]'s value is changed (following the same conditions as [signal value_changed]).
</description>
diff --git a/doc/classes/ScriptExtension.xml b/doc/classes/ScriptExtension.xml
new file mode 100644
index 0000000000..91fa6206d7
--- /dev/null
+++ b/doc/classes/ScriptExtension.xml
@@ -0,0 +1,173 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ScriptExtension" inherits="Script" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ <method name="_can_instantiate" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_editor_can_reload_from_file" qualifiers="virtual">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_base_script" qualifiers="virtual const">
+ <return type="Script" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_constants" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_documentation" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_instance_base_type" qualifiers="virtual const">
+ <return type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_language" qualifiers="virtual const">
+ <return type="ScriptLanguage" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_member_line" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="member" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_members" qualifiers="virtual const">
+ <return type="StringName[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_method_info" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="method" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_property_default_value" qualifiers="virtual const">
+ <return type="Variant" />
+ <argument index="0" name="property" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_rpc_methods" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_script_method_list" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_script_property_list" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_script_signal_list" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_source_code" qualifiers="virtual const">
+ <return type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_method" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="method" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_script_signal" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="signal" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_source_code" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_inherits_script" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="script" type="Script" />
+ <description>
+ </description>
+ </method>
+ <method name="_instance_create" qualifiers="virtual const">
+ <return type="void*" />
+ <argument index="0" name="for_object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_instance_has" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_placeholder_fallback_enabled" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_tool" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_valid" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_placeholder_erased" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="placeholder" type="void*" />
+ <description>
+ </description>
+ </method>
+ <method name="_placeholder_instance_create" qualifiers="virtual const">
+ <return type="void*" />
+ <argument index="0" name="for_object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_reload" qualifiers="virtual">
+ <return type="int" enum="Error" />
+ <argument index="0" name="keep_state" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_set_source_code" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="code" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_update_exports" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ </methods>
+</class>
diff --git a/doc/classes/ScriptLanguage.xml b/doc/classes/ScriptLanguage.xml
new file mode 100644
index 0000000000..b229e461f5
--- /dev/null
+++ b/doc/classes/ScriptLanguage.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ScriptLanguage" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+</class>
diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml
new file mode 100644
index 0000000000..7225d93030
--- /dev/null
+++ b/doc/classes/ScriptLanguageExtension.xml
@@ -0,0 +1,404 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ScriptLanguageExtension" inherits="ScriptLanguage" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ <method name="_add_global_constant" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="name" type="StringName" />
+ <argument index="1" name="value" type="Variant" />
+ <description>
+ </description>
+ </method>
+ <method name="_add_named_global_constant" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="name" type="StringName" />
+ <argument index="1" name="value" type="Variant" />
+ <description>
+ </description>
+ </method>
+ <method name="_alloc_instance_binding_data" qualifiers="virtual">
+ <return type="void*" />
+ <argument index="0" name="object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_auto_indent_code" qualifiers="virtual const">
+ <return type="String" />
+ <argument index="0" name="code" type="String" />
+ <argument index="1" name="from_line" type="int" />
+ <argument index="2" name="to_line" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_can_inherit_from_file" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_complete_code" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="code" type="String" />
+ <argument index="1" name="path" type="String" />
+ <argument index="2" name="owner" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_create_script" qualifiers="virtual const">
+ <return type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_current_stack_info" qualifiers="virtual">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_error" qualifiers="virtual const">
+ <return type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_globals" qualifiers="virtual">
+ <return type="Dictionary" />
+ <argument index="0" name="max_subitems" type="int" />
+ <argument index="1" name="max_depth" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_count" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_function" qualifiers="virtual const">
+ <return type="String" />
+ <argument index="0" name="level" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_instance" qualifiers="virtual">
+ <return type="void*" />
+ <argument index="0" name="level" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_line" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="level" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_locals" qualifiers="virtual">
+ <return type="Dictionary" />
+ <argument index="0" name="level" type="int" />
+ <argument index="1" name="max_subitems" type="int" />
+ <argument index="2" name="max_depth" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_get_stack_level_members" qualifiers="virtual">
+ <return type="Dictionary" />
+ <argument index="0" name="level" type="int" />
+ <argument index="1" name="max_subitems" type="int" />
+ <argument index="2" name="max_depth" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_debug_parse_stack_level_expression" qualifiers="virtual">
+ <return type="String" />
+ <argument index="0" name="level" type="int" />
+ <argument index="1" name="expression" type="String" />
+ <argument index="2" name="max_subitems" type="int" />
+ <argument index="3" name="max_depth" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_execute_file" qualifiers="virtual">
+ <return type="int" enum="Error" />
+ <argument index="0" name="path" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_find_function" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="class_name" type="String" />
+ <argument index="1" name="function_name" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_finish" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_frame" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_free_instance_binding_data" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="data" type="void*" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_built_in_templates" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <argument index="0" name="object" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_comment_delimiters" qualifiers="virtual const">
+ <return type="PackedStringArray" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_extension" qualifiers="virtual const">
+ <return type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_global_class_name" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="path" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_name" qualifiers="virtual const">
+ <return type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_public_constants" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_public_functions" qualifiers="virtual const">
+ <return type="Dictionary[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_recognized_extensions" qualifiers="virtual const">
+ <return type="PackedStringArray" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_reserved_words" qualifiers="virtual const">
+ <return type="PackedStringArray" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_string_delimiters" qualifiers="virtual const">
+ <return type="PackedStringArray" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_type" qualifiers="virtual const">
+ <return type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_handles_global_class_type" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="type" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_named_classes" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_init" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_control_flow_keyword" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="keyword" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_using_templates" qualifiers="virtual">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_lookup_code" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="code" type="String" />
+ <argument index="1" name="symbol" type="String" />
+ <argument index="2" name="path" type="String" />
+ <argument index="3" name="owner" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_make_function" qualifiers="virtual const">
+ <return type="String" />
+ <argument index="0" name="class_name" type="String" />
+ <argument index="1" name="function_name" type="String" />
+ <argument index="2" name="function_args" type="PackedStringArray" />
+ <description>
+ </description>
+ </method>
+ <method name="_make_template" qualifiers="virtual const">
+ <return type="Script" />
+ <argument index="0" name="template" type="String" />
+ <argument index="1" name="class_name" type="String" />
+ <argument index="2" name="base_class_name" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="_open_in_external_editor" qualifiers="virtual">
+ <return type="int" enum="Error" />
+ <argument index="0" name="script" type="Script" />
+ <argument index="1" name="line" type="int" />
+ <argument index="2" name="column" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_overrides_external_editor" qualifiers="virtual">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_profiling_get_accumulated_data" qualifiers="virtual">
+ <return type="int" />
+ <argument index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" />
+ <argument index="1" name="info_max" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_profiling_get_frame_data" qualifiers="virtual">
+ <return type="int" />
+ <argument index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" />
+ <argument index="1" name="info_max" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_profiling_start" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_profiling_stop" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_refcount_decremented_instance_binding" qualifiers="virtual">
+ <return type="bool" />
+ <argument index="0" name="object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_refcount_incremented_instance_binding" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="object" type="Object" />
+ <description>
+ </description>
+ </method>
+ <method name="_reload_all_scripts" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_reload_tool_script" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="script" type="Script" />
+ <argument index="1" name="soft_reload" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_remove_named_global_constant" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="name" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_supports_builtin_mode" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_supports_documentation" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_thread_enter" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_thread_exit" qualifiers="virtual">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ <method name="_validate" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="script" type="String" />
+ <argument index="1" name="path" type="String" />
+ <argument index="2" name="validate_functions" type="bool" />
+ <argument index="3" name="validate_errors" type="bool" />
+ <argument index="4" name="validate_warnings" type="bool" />
+ <argument index="5" name="validate_safe_lines" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_validate_path" qualifiers="virtual const">
+ <return type="String" />
+ <argument index="0" name="path" type="String" />
+ <description>
+ </description>
+ </method>
+ </methods>
+ <constants>
+ <constant name="LOOKUP_RESULT_SCRIPT_LOCATION" value="0" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS" value="1" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS_CONSTANT" value="2" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS_PROPERTY" value="3" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS_METHOD" value="4" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS_ENUM" value="5" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE" value="6" enum="LookupResultType">
+ </constant>
+ <constant name="LOOKUP_RESULT_MAX" value="7" enum="LookupResultType">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_CLASS" value="0" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_FUNCTION" value="1" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_SIGNAL" value="2" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_VARIABLE" value="3" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_MEMBER" value="4" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_ENUM" value="5" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_CONSTANT" value="6" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_NODE_PATH" value="7" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_FILE_PATH" value="8" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_PLAIN_TEXT" value="9" enum="CodeCompletionKind">
+ </constant>
+ <constant name="CODE_COMPLETION_KIND_MAX" value="10" enum="CodeCompletionKind">
+ </constant>
+ </constants>
+</class>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-29 22:01:15 +0000