godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Sync classref with current source 

Fix wrong hyperlinks in Control and Tree.
This commit is contained in:
Rémi Verschelde 2019-08-22 14:49:30 +02:00
parent 6d298cf311
commit 1349e0e585
15 changed files with 231 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/Control.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Control" inherits="CanvasItem" category="Core" version="3.2">
<brief_description>
All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent.
All user interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent.
</brief_description>
<description>
Base class for all UI-related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.
@ -49,10 +49,10 @@
[/codeblock]
The event won't trigger if:
* clicking outside the control (see [method has_point]);
* control has [member mouse_filter] set to [member MOUSE_FILTER_IGNORE];
* control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [member MOUSE_FILTER_IGNORE];
* control's parent has [member mouse_filter] set to [member MOUSE_FILTER_STOP] or has accepted the event;
* it happens outside parent's rectangle and the parent has either [member rect_clip_content] or [member _clips_input] enabled.
* control has [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE];
* control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE];
* control's parent has [member mouse_filter] set to [constant MOUSE_FILTER_STOP] or has accepted the event;
* it happens outside parent's rectangle and the parent has either [member rect_clip_content] or [method _clips_input] enabled.
</description>
</method>
<method name="_make_custom_tooltip" qualifiers="virtual">
@ -63,7 +63,7 @@
<description>
Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. Use [code]for_text[/code] parameter to determine what text the tooltip should contain (likely the contents of [member hint_tooltip]).
The returned node must be of type [Control] or Control-derieved. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance, not e.g. a node from scene. When null or non-Control node is returned, the default tooltip will be used instead.
[b]Note:[/b] The tooltip is shrunk to miminal size. If you want to ensure it's fully visible, you might want to set its [member rect_min_size] to some non-zero value.
[b]Note:[/b] The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its [member rect_min_size] to some non-zero value.
Example of usage with custom-constructed node:
[codeblock]
func _make_custom_tooltip(for_text):
@ -388,7 +388,7 @@
<argument index="0" name="at_position" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
Returns the tooltip, which will appear when the cursor is resting over this control. See [member]hint_tooltip[/member].
Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip].
</description>
</method>
<method name="grab_click_focus">

43
doc/classes/Crypto.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Crypto" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="generate_random_bytes">
<return type="PoolByteArray">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
</description>
</method>
<method name="generate_rsa">
<return type="CryptoKey">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
</description>
</method>
<method name="generate_self_signed_certificate">
<return type="X509Certificate">
</return>
<argument index="0" name="key" type="CryptoKey">
</argument>
<argument index="1" name="issuer_name" type="String" default="&quot;CN=myserver,O=myorganisation,C=IT&quot;">
</argument>
<argument index="2" name="not_before" type="String" default="&quot;20140101000000&quot;">
</argument>
<argument index="3" name="not_after" type="String" default="&quot;20340101000000&quot;">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

29
doc/classes/CryptoKey.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CryptoKey" inherits="Resource" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="load">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="save">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

41
doc/classes/HashingContext.xml Normal file
View File

@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HashingContext" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="finish">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="start">
<return type="int" enum="Error">
</return>
<argument index="0" name="type" type="int" enum="HashingContext.HashType">
</argument>
<description>
</description>
</method>
<method name="update">
<return type="int" enum="Error">
</return>
<argument index="0" name="chunk" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="HASH_MD5" value="0" enum="HashType">
</constant>
<constant name="HASH_SHA1" value="1" enum="HashType">
</constant>
<constant name="HASH_SHA256" value="2" enum="HashType">
</constant>
</constants>
</class>

6
doc/classes/PoolByteArray.xml
View File

@ -67,6 +67,12 @@
Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred.
</description>
</method>
<method name="hex_encode">
<return type="String">
</return>
<description>
</description>
</method>
<method name="insert">
<return type="int">
</return>

4
doc/classes/ProjectSettings.xml
View File

@ -664,6 +664,8 @@
</member>
<member name="network/limits/tcp/connect_timeout_seconds" type="int" setter="" getter="" default="30">
</member>
<member name="network/limits/webrtc/max_channel_in_buffer_kb" type="int" setter="" getter="" default="64">
</member>
<member name="network/limits/websocket_client/max_in_buffer_kb" type="int" setter="" getter="" default="64">
</member>
<member name="network/limits/websocket_client/max_in_packets" type="int" setter="" getter="" default="1024">
@ -686,6 +688,8 @@
<member name="network/remote_fs/page_size" type="int" setter="" getter="" default="65536">
Page size used by remote filesystem (in bytes).
</member>
<member name="network/ssl/certificates" type="String" setter="" getter="" default="&quot;&quot;">
</member>
<member name="node/name_casing" type="int" setter="" getter="" default="0">
When creating node names automatically, set the type of casing in this project. This is mostly an editor setting.
</member>

13
doc/classes/ResourceFormatLoaderCrypto.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceFormatLoaderCrypto" inherits="ResourceFormatLoader" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

13
doc/classes/ResourceFormatSaverCrypto.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceFormatSaverCrypto" inherits="ResourceFormatSaver" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

10
doc/classes/StreamPeerSSL.xml
View File

@ -13,7 +13,13 @@
<method name="accept_stream">
<return type="int" enum="Error">
</return>
<argument index="0" name="base" type="StreamPeer">
<argument index="0" name="stream" type="StreamPeer">
</argument>
<argument index="1" name="private_key" type="CryptoKey">
</argument>
<argument index="2" name="certificate" type="X509Certificate">
</argument>
<argument index="3" name="chain" type="X509Certificate" default="null">
</argument>
<description>
</description>
@ -27,6 +33,8 @@
</argument>
<argument index="2" name="for_hostname" type="String" default="&quot;&quot;">
</argument>
<argument index="3" name="valid_certificate" type="X509Certificate" default="null">
</argument>
<description>
Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code].
</description>

4
doc/classes/TextEdit.xml
View File

@ -418,6 +418,10 @@
<member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled" default="false">
If [code]true[/code], the line containing the cursor is highlighted.
</member>
<member name="minimap_draw" type="bool" setter="draw_minimap" getter="is_drawing_minimap" default="false">
</member>
<member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80">
</member>
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color" default="false">
</member>
<member name="readonly" type="bool" setter="set_readonly" getter="is_readonly" default="false">

2
doc/classes/Tree.xml
View File

@ -16,7 +16,7 @@
var subchild1 = tree.create_item(child1)
subchild1.set_text(0, "Subchild1")
[/codeblock]
To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_children] after getting the root through [get_root].
To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_children] after getting the root through [method get_root].
</description>
<tutorials>
</tutorials>

30
doc/classes/VisualShaderNodeCustom.xml
View File

@ -22,14 +22,6 @@
Override this method to define the category of the associated custom node in the Visual Shader Editor's members dialog.
Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the "Custom" category.
</description>
</method>
<method name="_get_description" qualifiers="virtual">
<return type="String">
</return>
<description>
Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog.
Defining this method is [b]optional[/b].
</description>
</method>
<method name="_get_code" qualifiers="virtual">
<return type="String">
@ -38,9 +30,9 @@
</argument>
<argument index="1" name="output_vars" type="Array">
</argument>
<argument index="2" name="mode" type="int" enum="Shader.Mode">
</argument>
<argument index="3" name="type" type="int" enum="VisualShader.Type">
<argument index="2" name="mode" type="int">
</argument>
<argument index="3" name="type" type="int">
</argument>
<description>
Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience).
@ -50,10 +42,18 @@
Defining this method is [b]required[/b].
</description>
</method>
<method name="_get_description" qualifiers="virtual">
<return type="String">
</return>
<description>
Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog.
Defining this method is [b]optional[/b].
</description>
</method>
<method name="_get_global_code" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="mode" type="int" enum="Shader.Mode">
<argument index="0" name="mode" type="int">
</argument>
<description>
Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience).
@ -81,7 +81,7 @@
</description>
</method>
<method name="_get_input_port_type" qualifiers="virtual">
<return type="int" enum="VisualShaderNode.PortType">
<return type="int">
</return>
<argument index="0" name="port" type="int">
</argument>
@ -117,7 +117,7 @@
</description>
</method>
<method name="_get_output_port_type" qualifiers="virtual">
<return type="int" enum="VisualShaderNode.PortType">
<return type="int">
</return>
<argument index="0" name="port" type="int">
</argument>
@ -127,7 +127,7 @@
</description>
</method>
<method name="_get_return_icon_type" qualifiers="virtual">
<return type="int" enum="VisualShaderNode.PortType">
<return type="int">
</return>
<description>
Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog.

13
doc/classes/VisualShaderNodeGlobalExpression.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeGlobalExpression" inherits="VisualShaderNodeExpression" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

4
doc/classes/VisualShaderNodeGroupBase.xml
View File

@ -208,6 +208,10 @@
</description>
</method>
</methods>
<members>
<member name="editable" type="bool" setter="set_editable" getter="is_editable" default="false">
</member>
</members>
<constants>
</constants>
</class>

29
doc/classes/X509Certificate.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="X509Certificate" inherits="Resource" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="load">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="save">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>