Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 21:31:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added more newly extracted class docs.

Browse Source
This commit is contained in:
Relintai 2023-06-13 17:55:03 +02:00
parent b7a369a5e1
commit 24df83cd32
6 changed files with 250 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
doc/classes/CodeHighlighter.xml Normal file
View File

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CodeHighlighter" inherits="SyntaxHighlighter" version="3.12">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_color_region">
<return type="void" />
<argument index="0" name="p_start_key" type="String" />
<argument index="1" name="p_end_key" type="String" />
<argument index="2" name="p_color" type="Color" />
<argument index="3" name="p_line_only" type="bool" default="false" />
<description>
</description>
</method>
<method name="add_keyword_color">
<return type="void" />
<argument index="0" name="keyword" type="String" />
<argument index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="add_member_keyword_color">
<return type="void" />
<argument index="0" name="member_keyword" type="String" />
<argument index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="clear_color_regions">
<return type="void" />
<description>
</description>
</method>
<method name="clear_keyword_colors">
<return type="void" />
<description>
</description>
</method>
<method name="clear_member_keyword_colors">
<return type="void" />
<description>
</description>
</method>
<method name="get_keyword_color" qualifiers="const">
<return type="Color" />
<argument index="0" name="keyword" type="String" />
<description>
</description>
</method>
<method name="get_member_keyword_color" qualifiers="const">
<return type="Color" />
<argument index="0" name="member_keyword" type="String" />
<description>
</description>
</method>
<method name="has_color_region" qualifiers="const">
<return type="bool" />
<argument index="0" name="p_start_key" type="String" />
<description>
</description>
</method>
<method name="has_keyword_color" qualifiers="const">
<return type="bool" />
<argument index="0" name="keyword" type="String" />
<description>
</description>
</method>
<method name="has_member_keyword_color" qualifiers="const">
<return type="bool" />
<argument index="0" name="member_keyword" type="String" />
<description>
</description>
</method>
<method name="remove_color_region">
<return type="void" />
<argument index="0" name="p_start_key" type="String" />
<description>
</description>
</method>
<method name="remove_keyword_color">
<return type="void" />
<argument index="0" name="keyword" type="String" />
<description>
</description>
</method>
<method name="remove_member_keyword_color">
<return type="void" />
<argument index="0" name="member_keyword" type="String" />
<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>

45
doc/classes/SyntaxHighlighter.xml Normal file
View File

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

57
doc/classes/TextEdit.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextEdit" inherits="Control" version="3.11">
<class name="TextEdit" inherits="Control" version="3.12">
<brief_description>
Multiline text editing control.
</brief_description>
@ -10,24 +10,6 @@
<tutorials>
</tutorials>
<methods>
<method name="add_color_region">
<return type="void" />
<argument index="0" name="begin_key" type="String" />
<argument index="1" name="end_key" type="String" />
<argument index="2" name="color" type="Color" />
<argument index="3" name="line_only" type="bool" default="false" />
<description>
Adds color region (given the delimiters) and its colors.
</description>
</method>
<method name="add_keyword_color">
<return type="void" />
<argument index="0" name="keyword" type="String" />
<argument index="1" name="color" type="Color" />
<description>
Adds a [code]keyword[/code] and its [Color].
</description>
</method>
<method name="can_fold" qualifiers="const">
<return type="bool" />
<argument index="0" name="line" type="int" />
@ -41,12 +23,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" />
<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" />
<description>
@ -123,13 +99,6 @@
Returns an array containing the line number of each breakpoint.
</description>
</method>
<method name="get_keyword_color" qualifiers="const">
<return type="Color" />
<argument index="0" name="keyword" type="String" />
<description>
Returns the [Color] of the specified [code]keyword[/code].
</description>
</method>
<method name="get_line" qualifiers="const">
<return type="String" />
<argument index="0" name="line" type="int" />
@ -257,13 +226,6 @@
Returns a [String] text with the word under the caret (text cursor) location.
</description>
</method>
<method name="has_keyword_color" qualifiers="const">
<return type="bool" />
<argument index="0" name="keyword" type="String" />
<description>
Returns whether the specified [code]keyword[/code] has a color set to it or not.
</description>
</method>
<method name="has_redo" qualifiers="const">
<return type="bool" />
<description>
@ -549,8 +511,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].
@ -584,6 +545,12 @@
Emitted when the info icon is clicked.
</description>
</signal>
<signal name="lines_edited_from">
<argument index="0" name="from_line" type="int" />
<argument index="1" name="to_line" type="int" />
<description>
</description>
</signal>
<signal name="request_completion">
<description>
</description>
@ -683,25 +650,17 @@
<theme_item name="font_color_selected" data_type="color" 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" data_type="color" type="Color" default="Color( 0.4, 0.64, 0.81, 1 )">
</theme_item>
<theme_item name="line_number_color" data_type="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>
<theme_item name="mark_color" data_type="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" data_type="color" type="Color" default="Color( 0.9, 0.31, 0.35, 1 )">
</theme_item>
<theme_item name="number_color" data_type="color" type="Color" default="Color( 0.92, 0.58, 0.2, 1 )">
</theme_item>
<theme_item name="safe_line_number_color" data_type="color" type="Color" default="Color( 0.67, 0.78, 0.67, 0.6 )">
</theme_item>
<theme_item name="selection_color" data_type="color" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )">
Sets the highlight [Color] of text selections.
</theme_item>
<theme_item name="symbol_color" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
</theme_item>
<theme_item name="word_highlighted_color" data_type="color" type="Color" default="Color( 0.8, 0.9, 0.9, 0.15 )">
Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled.
</theme_item>

53
editor_modules/editor_code_editor/doc_classes/EditorScriptEditorBase.xml Normal file
View File

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorScriptEditorBase" inherits="VBoxContainer" version="3.12">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<signals>
<signal name="edited_script_changed">
<description>
</description>
</signal>
<signal name="go_to_help">
<argument index="0" name="what" type="String" />
<description>
</description>
</signal>
<signal name="name_changed">
<description>
</description>
</signal>
<signal name="replace_in_files_requested">
<argument index="0" name="text" type="String" />
<description>
</description>
</signal>
<signal name="request_help">
<argument index="0" name="topic" type="String" />
<description>
</description>
</signal>
<signal name="request_open_script_at_line">
<argument index="0" name="script" type="Object" />
<argument index="1" name="line" type="int" />
<description>
</description>
</signal>
<signal name="request_save_history">
<description>
</description>
</signal>
<signal name="search_in_files_requested">
<argument index="0" name="text" type="String" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

28
editor_modules/editor_code_editor/doc_classes/EditorSyntaxHighlighter.xml Normal file
View File

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

2
modules/web/doc_classes/ListWebPage.xml
View File

@ -49,7 +49,7 @@
<member name="max_visible_navigation_links" type="int" setter="set_max_visible_navigation_links" getter="get_max_visible_navigation_links" default="6">
This many pagination links will be visible max.
</member>
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="true">
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="false">
Whether to allow pagination or not.
</member>
<member name="placeholder_text" type="String" setter="set_placeholder_text" getter="get_placeholder_text" default="&quot;No content yet!&quot;">