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 2018-01-03 13:45:03 +01:00
parent 6188279eeb
commit 8d03cafd7c
18 changed files with 275 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
doc/classes/@GlobalScope.xml
View file

@ -93,6 +93,14 @@
<constant name="MARGIN_BOTTOM" value="3" enum="Margin">
Bottom margin, used usually for [Control] or [StyleBox] derived classes.
</constant>
<constant name="CORNER_TOP_LEFT" value="0" enum="Corner">
</constant>
<constant name="CORNER_TOP_RIGHT" value="1" enum="Corner">
</constant>
<constant name="CORNER_BOTTOM_RIGHT" value="2" enum="Corner">
</constant>
<constant name="CORNER_BOTTOM_LEFT" value="3" enum="Corner">
</constant>
<constant name="VERTICAL" value="1" enum="Orientation">
General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
</constant>
@ -1385,5 +1393,57 @@
<constant name="TYPE_MAX" value="27" enum="Variant.Type">
Marker for end of type constants.
</constant>
<constant name="OP_EQUAL" value="0" enum="Variant.Operator">
</constant>
<constant name="OP_NOT_EQUAL" value="1" enum="Variant.Operator">
</constant>
<constant name="OP_LESS" value="2" enum="Variant.Operator">
</constant>
<constant name="OP_LESS_EQUAL" value="3" enum="Variant.Operator">
</constant>
<constant name="OP_GREATER" value="4" enum="Variant.Operator">
</constant>
<constant name="OP_GREATER_EQUAL" value="5" enum="Variant.Operator">
</constant>
<constant name="OP_ADD" value="6" enum="Variant.Operator">
</constant>
<constant name="OP_SUBTRACT" value="7" enum="Variant.Operator">
</constant>
<constant name="OP_MULTIPLY" value="8" enum="Variant.Operator">
</constant>
<constant name="OP_DIVIDE" value="9" enum="Variant.Operator">
</constant>
<constant name="OP_NEGATE" value="10" enum="Variant.Operator">
</constant>
<constant name="OP_POSITIVE" value="11" enum="Variant.Operator">
</constant>
<constant name="OP_MODULE" value="12" enum="Variant.Operator">
</constant>
<constant name="OP_STRING_CONCAT" value="13" enum="Variant.Operator">
</constant>
<constant name="OP_SHIFT_LEFT" value="14" enum="Variant.Operator">
</constant>
<constant name="OP_SHIFT_RIGHT" value="15" enum="Variant.Operator">
</constant>
<constant name="OP_BIT_AND" value="16" enum="Variant.Operator">
</constant>
<constant name="OP_BIT_OR" value="17" enum="Variant.Operator">
</constant>
<constant name="OP_BIT_XOR" value="18" enum="Variant.Operator">
</constant>
<constant name="OP_BIT_NEGATE" value="19" enum="Variant.Operator">
</constant>
<constant name="OP_AND" value="20" enum="Variant.Operator">
</constant>
<constant name="OP_OR" value="21" enum="Variant.Operator">
</constant>
<constant name="OP_XOR" value="22" enum="Variant.Operator">
</constant>
<constant name="OP_NOT" value="23" enum="Variant.Operator">
</constant>
<constant name="OP_IN" value="24" enum="Variant.Operator">
</constant>
<constant name="OP_MAX" value="25" enum="Variant.Operator">
</constant>
</constants>
</class>

2
doc/classes/ARVRServer.xml
View file

@ -14,7 +14,7 @@
<method name="center_on_hmd">
<return type="void">
</return>
<argument index="0" name="rotation_mode" type="bool">
<argument index="0" name="rotation_mode" type="int" enum="ARVRServer.RotationMode">
</argument>
<argument index="1" name="keep_height" type="bool">
</argument>

2
doc/classes/AStar.xml
View file

@ -171,7 +171,7 @@
<method name="get_point_connections">
<return type="PoolIntArray">
</return>
<argument index="0" name="arg0" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
Returns an array with the ids of the points that form the connect with the given point.

32
doc/classes/BakedLightmap.xml
View file

@ -27,38 +27,28 @@
</method>
</methods>
<members>
<member name="bake_cell_size" type="float" setter="set_bake_cell_size" getter="get_bake_cell_size">
</member>
<member name="bake_energy" type="float" setter="set_energy" getter="get_energy">
</member>
<member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents">
</member>
<member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr">
</member>
<member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode">
</member>
<member name="bake_propagation" type="float" setter="set_propagation" getter="get_propagation">
</member>
<member name="bake_quality" type="int" setter="set_bake_quality" getter="get_bake_quality" enum="BakedLightmap.BakeQuality">
</member>
<member name="bake_subdiv" type="int" setter="set_bake_subdiv" getter="get_bake_subdiv" enum="BakedLightmap.Subdiv">
</member>
<member name="capture_subdiv" type="int" setter="set_capture_subdiv" getter="get_capture_subdiv" enum="BakedLightmap.Subdiv">
</member>
<member name="energy" type="float" setter="set_energy" getter="get_energy">
</member>
<member name="extents" type="Vector3" setter="set_extents" getter="get_extents">
</member>
<member name="hdr" type="bool" setter="set_hdr" getter="is_hdr">
<member name="capture_cell_size" type="float" setter="set_capture_cell_size" getter="get_capture_cell_size">
</member>
<member name="image_path" type="String" setter="set_image_path" getter="get_image_path">
</member>
<member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data">
</member>
<member name="propagation" type="float" setter="set_propagation" getter="get_propagation">
</member>
</members>
<constants>
<constant name="SUBDIV_128" value="0" enum="Subdiv">
</constant>
<constant name="SUBDIV_256" value="1" enum="Subdiv">
</constant>
<constant name="SUBDIV_512" value="2" enum="Subdiv">
</constant>
<constant name="SUBDIV_1024" value="3" enum="Subdiv">
</constant>
<constant name="SUBDIV_MAX" value="4" enum="Subdiv">
</constant>
<constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality">
</constant>
<constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality">

3
doc/classes/Camera.xml
View file

@ -150,9 +150,6 @@
<member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset">
The horizontal (Y) offset of the Camear viewport.
</member>
<member name="vaspect" type="bool" setter="set_vaspect" getter="get_vaspect">
A boolean representation of [member keep_aspect] in which [code]true[/code] is equivalent to [code]KEEP_WIDTH[/code].
</member>
</members>
<constants>
<constant name="PROJECTION_PERSPECTIVE" value="0" enum="Projection">

78
doc/classes/Image.xml
View file

@ -314,6 +314,22 @@
Loads an image from file [code]path[/code].
</description>
</method>
<method name="load_jpg_from_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="load_png_from_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="lock">
<return type="void">
</return>
@ -430,65 +446,67 @@
</constant>
<constant name="FORMAT_RGBA5551" value="7" enum="Format">
</constant>
<constant name="FORMAT_RF" value="8" enum="Format">
<constant name="FORMAT_RGB10A2" value="8" enum="Format">
</constant>
<constant name="FORMAT_RGF" value="9" enum="Format">
<constant name="FORMAT_RF" value="9" enum="Format">
</constant>
<constant name="FORMAT_RGBF" value="10" enum="Format">
<constant name="FORMAT_RGF" value="10" enum="Format">
</constant>
<constant name="FORMAT_RGBAF" value="11" enum="Format">
<constant name="FORMAT_RGBF" value="11" enum="Format">
</constant>
<constant name="FORMAT_RH" value="12" enum="Format">
<constant name="FORMAT_RGBAF" value="12" enum="Format">
</constant>
<constant name="FORMAT_RGH" value="13" enum="Format">
<constant name="FORMAT_RH" value="13" enum="Format">
</constant>
<constant name="FORMAT_RGBH" value="14" enum="Format">
<constant name="FORMAT_RGH" value="14" enum="Format">
</constant>
<constant name="FORMAT_RGBAH" value="15" enum="Format">
<constant name="FORMAT_RGBH" value="15" enum="Format">
</constant>
<constant name="FORMAT_RGBE9995" value="16" enum="Format">
<constant name="FORMAT_RGBAH" value="16" enum="Format">
</constant>
<constant name="FORMAT_DXT1" value="17" enum="Format">
<constant name="FORMAT_RGBE9995" value="17" enum="Format">
</constant>
<constant name="FORMAT_DXT3" value="18" enum="Format">
<constant name="FORMAT_DXT1" value="18" enum="Format">
</constant>
<constant name="FORMAT_DXT5" value="19" enum="Format">
<constant name="FORMAT_DXT3" value="19" enum="Format">
</constant>
<constant name="FORMAT_RGTC_R" value="20" enum="Format">
<constant name="FORMAT_DXT5" value="20" enum="Format">
</constant>
<constant name="FORMAT_RGTC_RG" value="21" enum="Format">
<constant name="FORMAT_RGTC_R" value="21" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBA" value="22" enum="Format">
<constant name="FORMAT_RGTC_RG" value="22" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBF" value="23" enum="Format">
<constant name="FORMAT_BPTC_RGBA" value="23" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format">
<constant name="FORMAT_BPTC_RGBF" value="24" enum="Format">
</constant>
<constant name="FORMAT_PVRTC2" value="25" enum="Format">
<constant name="FORMAT_BPTC_RGBFU" value="25" enum="Format">
</constant>
<constant name="FORMAT_PVRTC2A" value="26" enum="Format">
<constant name="FORMAT_PVRTC2" value="26" enum="Format">
</constant>
<constant name="FORMAT_PVRTC4" value="27" enum="Format">
<constant name="FORMAT_PVRTC2A" value="27" enum="Format">
</constant>
<constant name="FORMAT_PVRTC4A" value="28" enum="Format">
<constant name="FORMAT_PVRTC4" value="28" enum="Format">
</constant>
<constant name="FORMAT_ETC" value="29" enum="Format">
<constant name="FORMAT_PVRTC4A" value="29" enum="Format">
</constant>
<constant name="FORMAT_ETC2_R11" value="30" enum="Format">
<constant name="FORMAT_ETC" value="30" enum="Format">
</constant>
<constant name="FORMAT_ETC2_R11S" value="31" enum="Format">
<constant name="FORMAT_ETC2_R11" value="31" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RG11" value="32" enum="Format">
<constant name="FORMAT_ETC2_R11S" value="32" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RG11S" value="33" enum="Format">
<constant name="FORMAT_ETC2_RG11" value="33" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGB8" value="34" enum="Format">
<constant name="FORMAT_ETC2_RG11S" value="34" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format">
<constant name="FORMAT_ETC2_RGB8" value="35" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format">
<constant name="FORMAT_ETC2_RGBA8" value="36" enum="Format">
</constant>
<constant name="FORMAT_MAX" value="37" enum="Format">
<constant name="FORMAT_ETC2_RGB8A1" value="37" enum="Format">
</constant>
<constant name="FORMAT_MAX" value="38" enum="Format">
</constant>
<constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation">
</constant>

36
doc/classes/Input.xml
View file

@ -275,7 +275,7 @@
</return>
<argument index="0" name="image" type="Resource">
</argument>
<argument index="1" name="cursor_shape" type="int" default="CURSOR_ARROW">
<argument index="1" name="shape" type="int" enum="Input.CursorShape" default="0">
</argument>
<argument index="2" name="hotspot" type="Vector2" default="Vector2( 0, 0 )">
</argument>
@ -350,5 +350,39 @@
</constant>
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
</constant>
<constant name="CURSOR_ARROW" value="0" enum="CursorShape">
</constant>
<constant name="CURSOR_IBEAM" value="1" enum="CursorShape">
</constant>
<constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape">
</constant>
<constant name="CURSOR_CROSS" value="3" enum="CursorShape">
</constant>
<constant name="CURSOR_WAIT" value="4" enum="CursorShape">
</constant>
<constant name="CURSOR_BUSY" value="5" enum="CursorShape">
</constant>
<constant name="CURSOR_DRAG" value="6" enum="CursorShape">
</constant>
<constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape">
</constant>
<constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape">
</constant>
<constant name="CURSOR_VSIZE" value="9" enum="CursorShape">
</constant>
<constant name="CURSOR_HSIZE" value="10" enum="CursorShape">
</constant>
<constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape">
</constant>
<constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape">
</constant>
<constant name="CURSOR_MOVE" value="13" enum="CursorShape">
</constant>
<constant name="CURSOR_VSPLIT" value="14" enum="CursorShape">
</constant>
<constant name="CURSOR_HSPLIT" value="15" enum="CursorShape">
</constant>
<constant name="CURSOR_HELP" value="16" enum="CursorShape">
</constant>
</constants>
</class>

15
doc/classes/InputEvent.xml
View file

@ -28,13 +28,6 @@
Returns a [String] representation of the event.
</description>
</method>
<method name="get_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the event's ID.
</description>
</method>
<method name="is_action" qualifiers="const">
<return type="bool">
</return>
@ -83,14 +76,6 @@
Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code].
</description>
</method>
<method name="set_id">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="shortcut_match" qualifiers="const">
<return type="bool">
</return>

8
doc/classes/MenuButton.xml
View file

@ -18,6 +18,14 @@
Return the [PopupMenu] contained in this button.
</description>
</method>
<method name="set_disable_shortcuts">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<signals>
<signal name="about_to_show">

6
doc/classes/Physics2DServer.xml
View file

@ -1135,6 +1135,12 @@
<constant name="JOINT_DAMPED_SPRING" value="2" enum="JointType">
Constant to create damped spring joints.
</constant>
<constant name="JOINT_PARAM_BIAS" value="0" enum="JointParam">
</constant>
<constant name="JOINT_PARAM_MAX_BIAS" value="1" enum="JointParam">
</constant>
<constant name="JOINT_PARAM_MAX_FORCE" value="2" enum="JointParam">
</constant>
<constant name="DAMPED_STRING_REST_LENGTH" value="0" enum="DampedStringParam">
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
</constant>

16
doc/classes/SceneTree.xml
View file

@ -302,6 +302,14 @@
<description>
</description>
</method>
<method name="set_quit_on_go_back">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_refuse_new_network_connections">
<return type="void">
</return>
@ -402,13 +410,13 @@
</signal>
</signals>
<constants>
<constant name="GROUP_CALL_DEFAULT" value="0" enum="CallGroupFlags">
<constant name="GROUP_CALL_DEFAULT" value="0" enum="GroupCallFlags">
</constant>
<constant name="GROUP_CALL_REVERSE" value="1" enum="CallGroupFlags">
<constant name="GROUP_CALL_REVERSE" value="1" enum="GroupCallFlags">
</constant>
<constant name="GROUP_CALL_REALTIME" value="2" enum="CallGroupFlags">
<constant name="GROUP_CALL_REALTIME" value="2" enum="GroupCallFlags">
</constant>
<constant name="GROUP_CALL_UNIQUE" value="4" enum="CallGroupFlags">
<constant name="GROUP_CALL_UNIQUE" value="4" enum="GroupCallFlags">
</constant>
<constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode">
</constant>

16
doc/classes/ScriptEditor.xml
View file

@ -12,11 +12,11 @@
<method name="can_drop_data_fw" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="arg0" type="Vector2">
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Variant">
<argument index="1" name="data" type="Variant">
</argument>
<argument index="2" name="arg2" type="Control">
<argument index="2" name="from" type="Control">
</argument>
<description>
</description>
@ -24,11 +24,11 @@
<method name="drop_data_fw">
<return type="void">
</return>
<argument index="0" name="arg0" type="Vector2">
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Variant">
<argument index="1" name="data" type="Variant">
</argument>
<argument index="2" name="arg2" type="Control">
<argument index="2" name="from" type="Control">
</argument>
<description>
</description>
@ -43,9 +43,9 @@
<method name="get_drag_data_fw">
<return type="Variant">
</return>
<argument index="0" name="arg0" type="Vector2">
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Control">
<argument index="1" name="from" type="Control">
</argument>
<description>
</description>

56
doc/classes/Spatial.xml
View file

@ -34,26 +34,6 @@
Returns the current [World] resource this Spatial node is registered to.
</description>
</method>
<method name="rotate_object_local">
<return type="void">
</return>
<argument index="0" name="axis" type="Vector3">
</argument>
<argument index="1" name="angle" type="float">
</argument>
<description>
Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system.
</description>
</method>
<method name="scale_object_local">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<description>
Scales the local transformation by given 3D scale factors in object-local coordinate system.
</description>
</method>
<method name="global_rotate">
<return type="void">
</return>
@ -65,6 +45,14 @@
Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system.
</description>
</method>
<method name="global_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="global_translate">
<return type="void">
</return>
@ -151,6 +139,17 @@
Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians.
</description>
</method>
<method name="rotate_object_local">
<return type="void">
</return>
<argument index="0" name="axis" type="Vector3">
</argument>
<argument index="1" name="angle" type="float">
</argument>
<description>
Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system.
</description>
</method>
<method name="rotate_x">
<return type="void">
</return>
@ -178,6 +177,15 @@
Rotates the local transformation around the Z axis by angle in radians.
</description>
</method>
<method name="scale_object_local">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<description>
Scales the local transformation by given 3D scale factors in object-local coordinate system.
</description>
</method>
<method name="set_as_toplevel">
<return type="void">
</return>
@ -264,6 +272,14 @@
Changes the node's position by given offset [Vector3].
</description>
</method>
<method name="translate_object_local">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="update_gizmo">
<return type="void">
</return>

2
doc/classes/TextEdit.xml
View file

@ -213,7 +213,7 @@
<method name="is_line_hidden" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="arg0" type="int">
<argument index="0" name="line" type="int">
</argument>
<description>
</description>

2
doc/classes/TileMap.xml
View file

@ -185,7 +185,7 @@
<method name="update_bitmask_area">
<return type="void">
</return>
<argument index="0" name="arg0" type="Vector2">
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates.

6
doc/classes/TileSet.xml
View file

@ -39,7 +39,7 @@
<method name="autotile_get_bitmask_mode" qualifiers="const">
<return type="int" enum="TileSet.BitmaskMode">
</return>
<argument index="0" name="arg0" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
@ -47,9 +47,9 @@
<method name="autotile_set_bitmask_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="arg1" type="int" enum="TileSet.BitmaskMode">
<argument index="1" name="mode" type="int" enum="TileSet.BitmaskMode">
</argument>
<description>
</description>

2
doc/classes/Tree.xml
View file

@ -41,6 +41,8 @@
</return>
<argument index="0" name="parent" type="Object" default="null">
</argument>
<argument index="1" name="idx" type="int" default="-1">
</argument>
<description>
Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty.
</description>

42
modules/gridmap/doc_classes/GridMap.xml
View file

@ -95,6 +95,22 @@
Returns whether or not grid items are centered on the Z axis.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="bit" type="int">
</argument>
<description>
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="bit" type="int">
</argument>
<description>
</description>
</method>
<method name="get_meshes">
<return type="Array">
</return>
@ -222,6 +238,26 @@
<description>
</description>
</method>
<method name="set_collision_layer_bit">
<return type="void">
</return>
<argument index="0" name="bit" type="int">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void">
</return>
<argument index="0" name="bit" type="int">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_octant_size">
<return type="void">
</return>
@ -249,6 +285,12 @@
</description>
</method>
</methods>
<members>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
</members>
<constants>
<constant name="INVALID_CELL_ITEM" value="-1">
Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]).