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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2021-04-19 12:26:37 +02:00
parent 8ba06e3161
commit 29775a1714
No known key found for this signature in database
GPG key ID: C3336907360768E1
7 changed files with 257 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/ColorPicker.xml
View file

@ -51,7 +51,7 @@
If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.
[b]Note:[/b] Cannot be enabled if raw mode is on.
</member>
<member name="picker_shape" type="int" setter="set_picker_shape" getter="get_picker_shape" default="0">
<member name="picker_shape" type="int" setter="set_picker_shape" getter="get_picker_shape" enum="ColorPicker.PickerShapeType" default="0">
The shape of the color space view. See [enum PickerShapeType].
</member>
<member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled" default="true">
@ -122,6 +122,8 @@
<theme_item name="overbright_indicator" type="Texture2D">
The indicator used to signalize that the color value is outside the 0-1 range.
</theme_item>
<theme_item name="picker_cursor" type="Texture2D">
</theme_item>
<theme_item name="preset_bg" type="Texture2D">
</theme_item>
<theme_item name="screen_picker" type="Texture2D">

2
doc/classes/Node.xml
View file

@ -38,7 +38,7 @@
</description>
</method>
<method name="_get_configuration_warnings" qualifiers="virtual">
<return type="Array">
<return type="String[]">
</return>
<description>
The elements in the array returned from this method are displayed as warnings in the Scene Dock if the script that overrides it is a [code]tool[/code] script.

240
doc/classes/PackedByteArray.xml
View file

@ -61,6 +61,114 @@
Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="decode_double" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_float" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_half" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_s16" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_s32" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_s64" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_s8" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_u16" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_u32" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_u64" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_u8" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<description>
</description>
</method>
<method name="decode_var" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="allow_objects" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="decode_var_size" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="allow_objects" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="decompress" qualifiers="const">
<return type="PackedByteArray">
</return>
@ -92,6 +200,128 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="encode_double">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="encode_float">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="encode_half">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="encode_s16">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_s32">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_s64">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_s8">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_u16">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_u32">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_u64">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_u8">
<return type="void">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="encode_var">
<return type="int">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<argument index="2" name="allow_objects" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="get_string_from_ascii" qualifiers="const">
<return type="String">
</return>
@ -129,6 +359,16 @@
Returns [code]true[/code] if the array contains [code]value[/code].
</description>
</method>
<method name="has_encoded_var" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="byte_offset" type="int">
</argument>
<argument index="1" name="allow_objects" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="hex_encode" qualifiers="const">
<return type="String">
</return>

8
doc/classes/PackedFloat32Array.xml
View file

@ -111,6 +111,14 @@
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="push_back">
<return type="bool">
</return>

2
doc/classes/ProjectSettings.xml
View file

@ -1149,7 +1149,7 @@
<member name="navigation/3d/default_cell_size" type="float" setter="" getter="" default="0.3">
Default cell size for 3D navigation maps. See [method NavigationServer3D.map_set_cell_size].
</member>
<member name="navigation/3d/default_edge_connection_margin" type="float" setter="" getter="" default="5.0">
<member name="navigation/3d/default_edge_connection_margin" type="float" setter="" getter="" default="0.3">
Default edge connection margin for 3D navigation maps. See [method NavigationServer3D.map_set_edge_connection_margin].
</member>
<member name="network/limits/debugger/max_chars_per_second" type="int" setter="" getter="" default="32768">

4
doc/classes/VisualShader.xml
View file

@ -228,7 +228,9 @@
</constant>
<constant name="TYPE_END" value="5" enum="Type">
</constant>
<constant name="TYPE_MAX" value="6" enum="Type">
<constant name="TYPE_SKY" value="6" enum="Type">
</constant>
<constant name="TYPE_MAX" value="7" enum="Type">
Represents the size of the [enum Type] enum.
</constant>
<constant name="NODE_ID_INVALID" value="-1">

1
scene/resources/visual_shader.cpp
View file

@ -1668,6 +1668,7 @@ void VisualShader::_bind_methods() {
BIND_ENUM_CONSTANT(TYPE_EMIT);
BIND_ENUM_CONSTANT(TYPE_PROCESS);
BIND_ENUM_CONSTANT(TYPE_END);
BIND_ENUM_CONSTANT(TYPE_SKY);
BIND_ENUM_CONSTANT(TYPE_MAX);
BIND_CONSTANT(NODE_ID_INVALID);