asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2020-07-15 08:43:21 +02:00
parent 9bda8df46c
commit b79aa89796
7 changed files with 332 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

145
doc/classes/CodeHighlighter.xml Normal file
View file

@ -0,0 +1,145 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CodeHighlighter" inherits="SyntaxHighlighter" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_color_region">
<return type="void">
</return>
<argument index="0" name="p_start_key" type="String">
</argument>
<argument index="1" name="p_end_key" type="String">
</argument>
<argument index="2" name="p_color" type="Color">
</argument>
<argument index="3" name="p_line_only" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="add_keyword_color">
<return type="void">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="add_member_keyword_color">
<return type="void">
</return>
<argument index="0" name="member_keyword" type="String">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="clear_color_regions">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_keyword_colors">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_member_keyword_colors">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_keyword_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<description>
</description>
</method>
<method name="get_member_keyword_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="member_keyword" type="String">
</argument>
<description>
</description>
</method>
<method name="has_color_region" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="p_start_key" type="String">
</argument>
<description>
</description>
</method>
<method name="has_keyword_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<description>
</description>
</method>
<method name="has_member_keyword_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="member_keyword" type="String">
</argument>
<description>
</description>
</method>
<method name="remove_color_region">
<return type="void">
</return>
<argument index="0" name="p_start_key" type="String">
</argument>
<description>
</description>
</method>
<method name="remove_keyword_color">
<return type="void">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<description>
</description>
</method>
<method name="remove_member_keyword_color">
<return type="void">
</return>
<argument index="0" name="member_keyword" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="color_regions" type="Dictionary" setter="set_color_regions" getter="get_color_regions" default="{}">
</member>
<member name="function_color" type="Color" setter="set_function_color" getter="get_function_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="keyword_colors" type="Dictionary" setter="set_keyword_colors" getter="get_keyword_colors" default="{}">
</member>
<member name="member_keyword_colors" type="Dictionary" setter="set_member_keyword_colors" getter="get_member_keyword_colors" default="{}">
</member>
<member name="member_variable_color" type="Color" setter="set_member_variable_color" getter="get_member_variable_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="number_color" type="Color" setter="set_number_color" getter="get_number_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="symbol_color" type="Color" setter="set_symbol_color" getter="get_symbol_color" default="Color( 0, 0, 0, 1 )">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/CollisionObject2D.xml
View file

@ -216,7 +216,7 @@
</method>
</methods>
<members>
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable">
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable" default="true">
If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events.
</member>
</members>

31
doc/classes/EditorSyntaxHighlighter.xml Normal file
View file

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_name" qualifiers="virtual">
<return type="String">
</return>
<description>
</description>
</method>
<method name="_get_supported_extentions" qualifiers="virtual">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="_get_supported_languages" qualifiers="virtual">
<return type="Array">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

28
doc/classes/ScriptEditor.xml
View file

@ -33,6 +33,12 @@
<description>
</description>
</method>
<method name="get_current_editor" qualifiers="const">
<return type="ScriptEditorBase">
</return>
<description>
</description>
</method>
<method name="get_current_script">
<return type="Script">
</return>
@ -50,6 +56,12 @@
<description>
</description>
</method>
<method name="get_open_script_editors" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_open_scripts" qualifiers="const">
<return type="Array">
</return>
@ -76,6 +88,22 @@
<description>
</description>
</method>
<method name="register_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
</description>
</method>
<method name="unregister_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
</description>
</method>
</methods>
<signals>
<signal name="editor_script_changed">

67
doc/classes/ScriptEditorBase.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditorBase" inherits="VBoxContainer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_syntax_highlighter" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="highlighter" type="Object">
</argument>
<description>
</description>
</method>
</methods>
<signals>
<signal name="edited_script_changed">
<description>
</description>
</signal>
<signal name="go_to_help">
<argument index="0" name="what" type="String">
</argument>
<description>
</description>
</signal>
<signal name="name_changed">
<description>
</description>
</signal>
<signal name="replace_in_files_requested">
<argument index="0" name="text" type="String">
</argument>
<description>
</description>
</signal>
<signal name="request_help">
<argument index="0" name="topic" type="String">
</argument>
<description>
</description>
</signal>
<signal name="request_open_script_at_line">
<argument index="0" name="script" type="Object">
</argument>
<argument index="1" name="line" type="int">
</argument>
<description>
</description>
</signal>
<signal name="request_save_history">
<description>
</description>
</signal>
<signal name="search_in_files_requested">
<argument index="0" name="text" type="String">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

53
doc/classes/SyntaxHighlighter.xml Normal file
View file

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SyntaxHighlighter" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_line_syntax_highlighting" qualifiers="virtual">
<return type="Dictionary">
</return>
<argument index="0" name="p_line" type="int">
</argument>
<description>
</description>
</method>
<method name="_update_cache" qualifiers="virtual">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_highlighting_cache">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_line_syntax_highlighting">
<return type="Dictionary">
</return>
<argument index="0" name="p_line" type="int">
</argument>
<description>
</description>
</method>
<method name="get_text_edit">
<return type="TextEdit">
</return>
<description>
</description>
</method>
<method name="update_cache">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

68
doc/classes/TextEdit.xml
View file

@ -9,32 +9,6 @@
<tutorials>
</tutorials>
<methods>
<method name="add_color_region">
<return type="void">
</return>
<argument index="0" name="begin_key" type="String">
</argument>
<argument index="1" name="end_key" type="String">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<argument index="3" name="line_only" type="bool" default="false">
</argument>
<description>
Adds color region (given the delimiters) and its colors.
</description>
</method>
<method name="add_keyword_color">
<return type="void">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Adds a [code]keyword[/code] and its [Color].
</description>
</method>
<method name="can_fold" qualifiers="const">
<return type="bool">
</return>
@ -51,13 +25,6 @@
Centers the viewport on the line the editing cursor is at. This also resets the [member scroll_horizontal] value to [code]0[/code].
</description>
</method>
<method name="clear_colors">
<return type="void">
</return>
<description>
Clears all custom syntax coloring information previously added with [method add_color_region] or [method add_keyword_color].
</description>
</method>
<method name="clear_undo_history">
<return type="void">
</return>
@ -152,15 +119,6 @@
Returns an array containing the line number of each breakpoint.
</description>
</method>
<method name="get_keyword_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<description>
Returns the [Color] of the specified [code]keyword[/code].
</description>
</method>
<method name="get_line" qualifiers="const">
<return type="String">
</return>
@ -226,15 +184,6 @@
Returns a [String] text with the word under the mouse cursor location.
</description>
</method>
<method name="has_keyword_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="keyword" type="String">
</argument>
<description>
Returns whether the specified [code]keyword[/code] has a color set to it or not.
</description>
</method>
<method name="insert_text_at_cursor">
<return type="void">
</return>
@ -473,8 +422,7 @@
<member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled" default="false">
If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling.
</member>
<member name="syntax_highlighting" type="bool" setter="set_syntax_coloring" getter="is_syntax_coloring_enabled" default="false">
If [code]true[/code], any custom color properties that have been set for this [TextEdit] will be visible.
<member name="syntax_highlighter" type="SyntaxHighlighter" setter="set_syntax_highlighter" getter="get_syntax_highlighter">
</member>
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
String value of the [TextEdit].
@ -508,6 +456,12 @@
Emitted when the info icon is clicked.
</description>
</signal>
<signal name="line_edited_from">
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</signal>
<signal name="request_completion">
<description>
</description>
@ -627,8 +581,6 @@
<theme_item name="font_color_selected" type="Color" default="Color( 0, 0, 0, 1 )">
Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled.
</theme_item>
<theme_item name="function_color" type="Color" default="Color( 0.4, 0.64, 0.81, 1 )">
</theme_item>
<theme_item name="line_number_color" type="Color" default="Color( 0.67, 0.67, 0.67, 0.4 )">
Sets the [Color] of the line numbers. [member show_line_numbers] has to be enabled.
</theme_item>
@ -638,13 +590,9 @@
<theme_item name="mark_color" type="Color" default="Color( 1, 0.4, 0.4, 0.4 )">
Sets the [Color] of marked text.
</theme_item>
<theme_item name="member_variable_color" type="Color" default="Color( 0.9, 0.31, 0.35, 1 )">
</theme_item>
<theme_item name="normal" type="StyleBox">
Sets the [StyleBox] of this [TextEdit].
</theme_item>
<theme_item name="number_color" type="Color" default="Color( 0.92, 0.58, 0.2, 1 )">
</theme_item>
<theme_item name="read_only" type="StyleBox">
Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled.
</theme_item>
@ -655,8 +603,6 @@
</theme_item>
<theme_item name="space" type="Texture2D">
</theme_item>
<theme_item name="symbol_color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
</theme_item>
<theme_item name="tab" type="Texture2D">
Sets a custom [Texture2D] for tab text characters.
</theme_item>