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

doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc

Browse source
This commit is contained in:
Rémi Verschelde 2017-12-07 08:29:38 +01:00
parent 7d440d04aa
commit 624a2b08f3
33 changed files with 350 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/classes/AudioStreamSample.xml
View file

@ -11,11 +11,22 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
Raw audio data.
</member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
Audio format. See FORMAT_* constants for values.
</member>

7
doc/classes/BitMap.xml
View file

@ -75,13 +75,6 @@
</description>
</method>
</methods>
<members>
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data">
Returns a [Dictionary] with two keys :
[code]data[/code] : [PoolByteArray] with [code]true[/code]/[code]false[/code] [code]BitMap[/code] data.
[code]size[/code] : The [code]Bitmap[/code]'s size.
</member>
</members>
<constants>
</constants>
</class>

9
doc/classes/BitmapFont.xml
View file

@ -109,9 +109,6 @@
<member name="ascent" type="float" setter="set_ascent" getter="get_ascent">
Ascent (number of pixels above the baseline).
</member>
<member name="chars" type="PoolIntArray" setter="_set_chars" getter="_get_chars">
The characters in the BitmapFont.
</member>
<member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint">
If [code]true[/code] distance field hint is enabled.
</member>
@ -121,12 +118,6 @@
<member name="height" type="float" setter="set_height" getter="get_height">
Total font height (ascent plus descent) in pixels.
</member>
<member name="kernings" type="PoolIntArray" setter="_set_kernings" getter="_get_kernings">
The font's kernings as [PoolIntArray].
</member>
<member name="textures" type="Array" setter="_set_textures" getter="_get_textures">
The font's [Texture]s.
</member>
</members>
<constants>
</constants>

2
doc/classes/Curve.xml
View file

@ -169,8 +169,6 @@
</method>
</methods>
<members>
<member name="_data" type="Array" setter="_set_data" getter="_get_data">
</member>
<member name="bake_resolution" type="int" setter="set_bake_resolution" getter="get_bake_resolution">
</member>
<member name="max_value" type="float" setter="set_max_value" getter="get_max_value">

3
doc/classes/Curve2D.xml
View file

@ -175,9 +175,6 @@
</method>
</methods>
<members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data">
The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex.
</member>
<member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval">
The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
</member>

2
doc/classes/Curve3D.xml
View file

@ -202,8 +202,6 @@
</method>
</methods>
<members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data">
</member>
<member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval">
</member>
</members>

178
doc/classes/GIProbeData.xml
View file

@ -9,31 +9,161 @@
<demos>
</demos>
<methods>
<method name="get_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_bounds" qualifiers="const">
<return type="AABB">
</return>
<description>
</description>
</method>
<method name="get_cell_size" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_dynamic_data" qualifiers="const">
<return type="PoolIntArray">
</return>
<description>
</description>
</method>
<method name="get_dynamic_range" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_energy" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_normal_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_propagation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_to_cell_xform" qualifiers="const">
<return type="Transform">
</return>
<description>
</description>
</method>
<method name="is_compressed" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_interior" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_bias">
<return type="void">
</return>
<argument index="0" name="bias" type="float">
</argument>
<description>
</description>
</method>
<method name="set_bounds">
<return type="void">
</return>
<argument index="0" name="bounds" type="AABB">
</argument>
<description>
</description>
</method>
<method name="set_cell_size">
<return type="void">
</return>
<argument index="0" name="cell_size" type="float">
</argument>
<description>
</description>
</method>
<method name="set_compress">
<return type="void">
</return>
<argument index="0" name="compress" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_dynamic_data">
<return type="void">
</return>
<argument index="0" name="dynamic_data" type="PoolIntArray">
</argument>
<description>
</description>
</method>
<method name="set_dynamic_range">
<return type="void">
</return>
<argument index="0" name="dynamic_range" type="int">
</argument>
<description>
</description>
</method>
<method name="set_energy">
<return type="void">
</return>
<argument index="0" name="energy" type="float">
</argument>
<description>
</description>
</method>
<method name="set_interior">
<return type="void">
</return>
<argument index="0" name="interior" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_normal_bias">
<return type="void">
</return>
<argument index="0" name="bias" type="float">
</argument>
<description>
</description>
</method>
<method name="set_propagation">
<return type="void">
</return>
<argument index="0" name="propagation" type="float">
</argument>
<description>
</description>
</method>
<method name="set_to_cell_xform">
<return type="void">
</return>
<argument index="0" name="to_cell_xform" type="Transform">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bias" type="float" setter="set_bias" getter="get_bias">
</member>
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds">
</member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size">
</member>
<member name="compress" type="bool" setter="set_compress" getter="is_compressed">
</member>
<member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data">
</member>
<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range">
</member>
<member name="energy" type="float" setter="set_energy" getter="get_energy">
</member>
<member name="interior" type="bool" setter="set_interior" getter="is_interior">
</member>
<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias">
</member>
<member name="propagation" type="float" setter="set_propagation" getter="get_propagation">
</member>
<member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/ItemList.xml
View file

@ -332,8 +332,6 @@
</member>
<member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale">
</member>
<member name="items" type="Array" setter="_set_items" getter="_get_items">
</member>
<member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns">
</member>
<member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines">

8
doc/classes/LargeTexture.xml
View file

@ -87,14 +87,6 @@
</description>
</method>
</methods>
<members>
<member name="_data" type="Array" setter="_set_data" getter="_get_data">
Returns an [Array] with offsets and textures data of each added piece. Schema is [offsets1, texture1, offsets2, texture2, large_texture_size].
[code]offsets[/code] : [Vector2] offsets of the texture piece.
[code]second[/code] : [StreamTexture] data of the texture piece.
[code]last entry[/code] : [Vector2] size of the entire large texture.
</member>
</members>
<constants>
</constants>
</class>

4
doc/classes/MenuButton.xml
View file

@ -19,10 +19,6 @@
</description>
</method>
</methods>
<members>
<member name="items" type="Array" setter="_set_items" getter="_get_items">
</member>
</members>
<signals>
<signal name="about_to_show">
<description>

4
doc/classes/MultiMesh.xml
View file

@ -63,16 +63,12 @@
</method>
</methods>
<members>
<member name="color_array" type="PoolColorArray" setter="_set_color_array" getter="_get_color_array">
</member>
<member name="color_format" type="int" setter="set_color_format" getter="get_color_format" enum="MultiMesh.ColorFormat">
</member>
<member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count">
</member>
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
</member>
<member name="transform_array" type="PoolVector3Array" setter="_set_transform_array" getter="_get_transform_array">
</member>
<member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat">
</member>
</members>

18
doc/classes/NavigationMesh.xml
View file

@ -45,6 +45,20 @@
<description>
</description>
</method>
<method name="get_vertices" qualifiers="const">
<return type="PoolVector3Array">
</return>
<description>
</description>
</method>
<method name="set_vertices">
<return type="void">
</return>
<argument index="0" name="vertices" type="PoolVector3Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height">
@ -75,16 +89,12 @@
</member>
<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly">
</member>
<member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons">
</member>
<member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size">
</member>
<member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size">
</member>
<member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type">
</member>
<member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices">
</member>
</members>
<constants>
<constant name="SAMPLE_PARTITION_WATERSHED" value="0">

22
doc/classes/NavigationPolygon.xml
View file

@ -75,6 +75,12 @@
<description>
</description>
</method>
<method name="get_vertices" qualifiers="const">
<return type="PoolVector2Array">
</return>
<description>
</description>
</method>
<method name="make_polygons_from_outlines">
<return type="void">
</return>
@ -99,15 +105,15 @@
<description>
</description>
</method>
<method name="set_vertices">
<return type="void">
</return>
<argument index="0" name="vertices" type="PoolVector2Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="outlines" type="Array" setter="_set_outlines" getter="_get_outlines">
</member>
<member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons">
</member>
<member name="vertices" type="PoolVector2Array" setter="set_vertices" getter="get_vertices">
</member>
</members>
<constants>
</constants>
</class>

18
doc/classes/Node.xml
View file

@ -350,6 +350,12 @@
Returns [code]true[/code] if the "node" argument is a direct or indirect child of the current node, otherwise return [code]false[code].
</description>
</method>
<method name="is_displayed_folded" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_greater_than" qualifiers="const">
<return type="bool">
</return>
@ -641,6 +647,14 @@
Remotely changes property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol.
</description>
</method>
<method name="set_display_folded">
<return type="void">
</return>
<argument index="0" name="fold" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_filename">
<return type="void">
</return>
@ -750,10 +764,6 @@
</method>
</methods>
<members>
<member name="_import_path" type="NodePath" setter="_set_import_path" getter="_get_import_path">
</member>
<member name="editor/display_folded" type="bool" setter="set_display_folded" getter="is_displayed_folded">
</member>
<member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode">
</member>
</members>

17
doc/classes/Node2D.xml
View file

@ -38,6 +38,12 @@
Returns the [Transform2D] relative to this node's parent.
</description>
</method>
<method name="get_rotation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="global_translate">
<return type="void">
</return>
@ -87,6 +93,14 @@
Applies a rotation to the node, in radians, starting from its current rotation.
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
</description>
</method>
<method name="to_global" qualifiers="const">
<return type="Vector2">
</return>
@ -134,9 +148,6 @@
<member name="position" type="Vector2" setter="set_position" getter="get_position">
Position, relative to the node's parent.
</member>
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation">
Rotation in radians, relative to the node's parent.
</member>
<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
Rotation in degrees, relative to the node's parent.
</member>

2
doc/classes/OptionButton.xml
View file

@ -183,8 +183,6 @@
</method>
</methods>
<members>
<member name="items" type="Array" setter="_set_items" getter="_get_items">
</member>
<member name="selected" type="int" setter="_select_int" getter="get_selected">
</member>
</members>

4
doc/classes/PolygonPathFinder.xml
View file

@ -80,10 +80,6 @@
</description>
</method>
</methods>
<members>
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/PopupMenu.xml
View file

@ -423,8 +423,6 @@
</member>
<member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection">
</member>
<member name="items" type="Array" setter="_set_items" getter="_get_items">
</member>
</members>
<signals>
<signal name="id_pressed">

4
doc/classes/ResourcePreloader.xml
View file

@ -67,10 +67,6 @@
</description>
</method>
</methods>
<members>
<member name="resources" type="Array" setter="_set_resources" getter="_get_resources">
</member>
</members>
<constants>
</constants>
</class>

18
doc/classes/Shader.xml
View file

@ -11,6 +11,12 @@
<demos>
</demos>
<methods>
<method name="get_code" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_default_texture_param" qualifiers="const">
<return type="Texture">
</return>
@ -33,6 +39,14 @@
<description>
</description>
</method>
<method name="set_code">
<return type="void">
</return>
<argument index="0" name="code" type="String">
</argument>
<description>
</description>
</method>
<method name="set_default_texture_param">
<return type="void">
</return>
@ -44,10 +58,6 @@
</description>
</method>
</methods>
<members>
<member name="code" type="String" setter="set_code" getter="get_code">
</member>
</members>
<constants>
<constant name="MODE_SPATIAL" value="0" enum="Mode">
</constant>

3
doc/classes/SpriteFrames.xml
View file

@ -164,9 +164,6 @@
</method>
</methods>
<members>
<member name="animations" type="Array" setter="_set_animations" getter="_get_animations">
An [Array] containing the [code]name[/code], [code]speed[/code], [code]loop[/code], and [code]frames[/code] of each animation.
</member>
<member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
</member>
</members>

2
doc/classes/Translation.xml
View file

@ -57,8 +57,6 @@
<members>
<member name="locale" type="String" setter="set_locale" getter="get_locale">
</member>
<member name="messages" type="PoolStringArray" setter="_set_messages" getter="_get_messages">
</member>
</members>
<constants>
</constants>

53
modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml
View file

@ -11,18 +11,49 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_loop_offset" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_loop_offset">
<return type="void">
</return>
<argument index="0" name="seconds" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
Raw audio data.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
If [code]true[/code], audio will loop continuously. Default value: [code]false[/code].
</member>
<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset">
If loop is [code]true[/code], loop starts from this position, in seconds.
</member>
</members>
<constants>
</constants>
</class>

18
modules/theora/doc_classes/VideoStreamTheora.xml
View file

@ -9,11 +9,21 @@
<demos>
</demos>
<methods>
<method name="get_file">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="file" type="String" setter="set_file" getter="get_file">
</member>
</members>
<constants>
</constants>
</class>

4
modules/visual_script/doc_classes/VisualScript.xml
View file

@ -495,10 +495,6 @@
</description>
</method>
</methods>
<members>
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data">
</member>
</members>
<signals>
<signal name="node_ports_changed">
<argument index="0" name="function" type="String">

52
modules/visual_script/doc_classes/VisualScriptConstructor.xml
View file

@ -11,31 +11,35 @@
<demos>
</demos>
<methods>
<method name="get_constructor" qualifiers="const">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_constructor_type" qualifiers="const">
<return type="int" enum="Variant.Type">
</return>
<description>
</description>
</method>
<method name="set_constructor">
<return type="void">
</return>
<argument index="0" name="constructor" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_constructor_type">
<return type="void">
</return>
<argument index="0" name="type" type="int" enum="Variant.Type">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="constructor" type="Dictionary" setter="set_constructor" getter="get_constructor">
The constructor function's method info. Has roughly the following structure:
[codeblock]
{
name = "string",
args = [{
name = "string"
class_name = "string"
type = TYPE_*
hint = PROPERTY_HINT_*
hint_string = "string"
}]
default_args = [] # Array of variants
flags = METHOD_FLAG_*
id = 0
return = {type = TYPE_*}
}
[/codeblock]
</member>
<member name="type" type="int" setter="set_constructor_type" getter="get_constructor_type" enum="Variant.Type">
The type to be constructed.
</member>
</members>
<constants>
</constants>
</class>

2
modules/visual_script/doc_classes/VisualScriptDeconstruct.xml
View file

@ -13,8 +13,6 @@
<methods>
</methods>
<members>
<member name="elem_cache" type="Array" setter="_set_elem_cache" getter="_get_elem_cache">
</member>
<member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" enum="Variant.Type">
The type to deconstruct.
</member>

2
modules/visual_script/doc_classes/VisualScriptFunctionCall.xml
View file

@ -11,8 +11,6 @@
<methods>
</methods>
<members>
<member name="argument_cache" type="Dictionary" setter="_set_argument_cache" getter="_get_argument_cache">
</member>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">

4
modules/visual_script/doc_classes/VisualScriptNode.xml
View file

@ -46,10 +46,6 @@
</description>
</method>
</methods>
<members>
<member name="_default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values">
</member>
</members>
<signals>
<signal name="ports_changed">
<description>

2
modules/visual_script/doc_classes/VisualScriptPropertyGet.xml
View file

@ -25,8 +25,6 @@
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode">
</member>
<member name="type_cache" type="int" setter="_set_type_cache" getter="_get_type_cache" enum="Variant.Type">
</member>
</members>
<constants>
<constant name="CALL_MODE_SELF" value="0" enum="CallMode">

2
modules/visual_script/doc_classes/VisualScriptPropertySet.xml
View file

@ -27,8 +27,6 @@
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode">
</member>
<member name="type_cache" type="Dictionary" setter="_set_type_cache" getter="_get_type_cache">
</member>
</members>
<constants>
<constant name="CALL_MODE_SELF" value="0" enum="CallMode">

16
modules/visual_script/doc_classes/VisualScriptYield.xml
View file

@ -9,10 +9,22 @@
<demos>
</demos>
<methods>
<method name="get_yield_mode">
<return type="int" enum="VisualScriptYield.YieldMode">
</return>
<description>
</description>
</method>
<method name="set_yield_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="VisualScriptYield.YieldMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode">
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">
</member>
</members>

18
modules/webm/doc_classes/VideoStreamWebm.xml
View file

@ -9,11 +9,21 @@
<demos>
</demos>
<methods>
<method name="get_file">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="file" type="String" setter="set_file" getter="get_file">
</member>
</members>
<constants>
</constants>
</class>