diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 19 | ||||
| -rw-r--r-- | doc/base/classes.xml | 4908 | ||||
| -rw-r--r--[-rwxr-xr-x] | doc/tools/doc_status.py | 0 | ||||
| -rw-r--r-- | doc/tools/locales/es/LC_MESSAGES/makedocs.mo | bin | 2321 -> 0 bytes | |||
| -rw-r--r-- | doc/tools/locales/es/LC_MESSAGES/makedocs.po | 142 | ||||
| -rw-r--r-- | doc/tools/main.css | 146 | ||||
| -rw-r--r-- | doc/tools/makedocs.pot | 108 | ||||
| -rw-r--r-- | doc/tools/makedocs.py | 383 | ||||
| -rw-r--r-- | doc/tools/makedoku.py | 499 | ||||
| -rw-r--r-- | doc/tools/makehtml.py | 689 | ||||
| -rw-r--r-- | doc/tools/makemd.py | 6 | ||||
| -rw-r--r-- | doc/tools/makerst.py | 6 |
12 files changed, 2758 insertions, 4148 deletions
diff --git a/doc/Makefile b/doc/Makefile index d59c77063b..4914c657d2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -8,25 +8,11 @@ TOOLSDIR = $(BASEDIR)/tools clean: rm -rf $(OUTPUTDIR) -doku: - rm -rf $(OUTPUTDIR)/doku - mkdir -p $(OUTPUTDIR)/doku - pushd $(OUTPUTDIR)/doku - python2 $(TOOLSDIR)/makedoku.py $(CLASSES) - popd - doxygen: rm -rf $(OUTPUTDIR)/doxygen mkdir -p $(OUTPUTDIR)/doxygen doxygen Doxyfile -html: - rm -rf $(OUTPUTDIR)/html - mkdir -p $(OUTPUTDIR)/html - pushd $(OUTPUTDIR)/html - python2 $(TOOLSDIR)/makehtml.py -multipage $(CLASSES) - popd - markdown: rm -rf $(OUTPUTDIR)/markdown mkdir -p $(OUTPUTDIR)/markdown @@ -40,8 +26,3 @@ rst: pushd $(OUTPUTDIR)/rst python2 $(TOOLSDIR)/makerst.py $(CLASSES) popd - -textile: - rm -rf $(OUTPUTDIR)/textile - mkdir -p $(OUTPUTDIR)/textile - python3 $(TOOLSDIR)/makedocs.py --input $(CLASSES) --output $(OUTPUTDIR)/textile diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 03dd151eb2..2139d1a467 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,15 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> <doc version="3.0.alpha.custom_build" name="Engine Types"> -<class name="@DLScript" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> <class name="@GDScript" category="Core"> <brief_description> Built-in GDScript functions. @@ -1914,45 +1904,49 @@ <constant name="TYPE_COLOR" value="14"> Variable is of type [Color]. </constant> - <constant name="TYPE_IMAGE" value="15"> - Variable is of type [Image]. - </constant> - <constant name="TYPE_NODE_PATH" value="16"> + <constant name="TYPE_NODE_PATH" value="15"> Variable is of type [NodePath]. </constant> - <constant name="TYPE_RID" value="17"> + <constant name="TYPE_RID" value="16"> Variable is of type [RID]. </constant> - <constant name="TYPE_OBJECT" value="18"> + <constant name="TYPE_OBJECT" value="17"> Variable is of type [Object]. </constant> - <constant name="TYPE_INPUT_EVENT" value="19"> - Variable is of type [InputEvent]. - </constant> - <constant name="TYPE_DICTIONARY" value="20"> + <constant name="TYPE_DICTIONARY" value="18"> Variable is of type [Dictionary]. </constant> - <constant name="TYPE_ARRAY" value="21"> + <constant name="TYPE_ARRAY" value="19"> Variable is of type [Array]. </constant> - <constant name="TYPE_RAW_ARRAY" value="22"> + <constant name="TYPE_RAW_ARRAY" value="20"> </constant> - <constant name="TYPE_INT_ARRAY" value="23"> + <constant name="TYPE_INT_ARRAY" value="21"> </constant> - <constant name="TYPE_REAL_ARRAY" value="24"> + <constant name="TYPE_REAL_ARRAY" value="22"> </constant> - <constant name="TYPE_STRING_ARRAY" value="25"> + <constant name="TYPE_STRING_ARRAY" value="23"> </constant> - <constant name="TYPE_VECTOR2_ARRAY" value="26"> + <constant name="TYPE_VECTOR2_ARRAY" value="24"> </constant> - <constant name="TYPE_VECTOR3_ARRAY" value="27"> + <constant name="TYPE_VECTOR3_ARRAY" value="25"> </constant> - <constant name="TYPE_COLOR_ARRAY" value="28"> + <constant name="TYPE_COLOR_ARRAY" value="26"> </constant> - <constant name="TYPE_MAX" value="29"> + <constant name="TYPE_MAX" value="27"> </constant> </constants> </class> +<class name="@Native" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> <class name="@VisualScript" category="Core"> <brief_description> </brief_description> @@ -1993,6 +1987,7 @@ <argument index="2" name="weight_scale" type="float" default="1"> </argument> <description> + Add a new point at the given position. The [code]weight_scale[/code] has to be 1 or larger. </description> </method> <method name="are_points_connected" qualifiers="const"> @@ -2014,6 +2009,8 @@ </argument> <argument index="1" name="to_id" type="int"> </argument> + <argument index="2" name="bidirectional" type="bool" default="true"> + </argument> <description> </description> </method> @@ -2985,7 +2982,7 @@ Return the default blend time between animations. </description> </method> - <method name="get_position" qualifiers="const"> + <method name="get_pos" qualifiers="const"> <return type="float"> </return> <description> @@ -3756,6 +3753,22 @@ Return the angular damp rate. </description> </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the layer mask. + </description> + </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> @@ -3793,22 +3806,6 @@ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> - <method name="get_layer_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> - </argument> - <description> - Return an individual bit on the layer mask. - </description> - </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> @@ -3891,6 +3888,24 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> + <method name="set_collision_layer"> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + </description> + </method> + <method name="set_collision_layer_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + </description> + </method> <method name="set_collision_mask"> <argument index="0" name="collision_mask" type="int"> </argument> @@ -3937,24 +3952,6 @@ If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> - </argument> - <description> - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - </description> - </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. - </description> - </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> @@ -4001,7 +3998,7 @@ <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" brief=""> </member> - <member name="collision_layers" type="int" setter="set_layer_mask" getter="get_layer_mask" brief=""> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" brief=""> </member> @@ -4124,6 +4121,22 @@ Return the angular damp rate. </description> </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the layer mask. + </description> + </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> @@ -4161,22 +4174,6 @@ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> - <method name="get_layer_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> - </argument> - <description> - Return an individual bit on the layer mask. - </description> - </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> @@ -4259,6 +4256,24 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> + <method name="set_collision_layer"> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + </description> + </method> + <method name="set_collision_layer_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + </description> + </method> <method name="set_collision_mask"> <argument index="0" name="collision_mask" type="int"> </argument> @@ -4305,24 +4320,6 @@ If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> - </argument> - <description> - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - </description> - </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. - </description> - </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> @@ -4369,7 +4366,7 @@ <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" brief=""> </member> - <member name="collision_layers" type="int" setter="set_layer_mask" getter="get_layer_mask" brief=""> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" brief=""> </member> @@ -4717,6 +4714,251 @@ <constants> </constants> </class> +<class name="ArrayMesh" inherits="Mesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="add_blend_shape"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_surface_from_arrays"> + <argument index="0" name="primitive" type="int"> + </argument> + <argument index="1" name="arrays" type="Array"> + </argument> + <argument index="2" name="blend_shapes" type="Array" default="[]"> + </argument> + <argument index="3" name="compress_flags" type="int" default="97792"> + </argument> + <description> + Create a new surface ([method get_surface_count] that will become surf_idx for this. + Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). + </description> + </method> + <method name="center_geometry"> + <description> + </description> + </method> + <method name="clear_blend_shapes"> + <description> + </description> + </method> + <method name="get_blend_shape_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_blend_shape_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_blend_shape_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_custom_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="get_surface_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of surfaces that the [ArrayMesh] holds. + </description> + </method> + <method name="regen_normalmaps"> + <description> + </description> + </method> + <method name="set_blend_shape_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_custom_aabb"> + <argument index="0" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="surface_get_array_index_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the length in indices of the index array in the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_array_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_format" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the format mask of the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_material" qualifiers="const"> + <return type="Material"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return a [Material] in a given surface. Surface is rendered using this material. + </description> + </method> + <method name="surface_get_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="surface_get_primitive_type" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the primitive type of the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_remove"> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. + </description> + </method> + <method name="surface_set_material"> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <description> + </description> + </method> + <method name="surface_set_name"> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Set a [Material] for a given surface. Surface will be rendered using this material. + </description> + </method> + </methods> + <constants> + <constant name="NO_INDEX_ARRAY" value="-1"> + Default value used for index_array_len when no indices are present. + </constant> + <constant name="ARRAY_WEIGHTS_SIZE" value="4"> + Amount of weights/bone indices per vertex (always 4). + </constant> + <constant name="ARRAY_VERTEX" value="0"> + Vertex array (array of [Vector3] vertices). + </constant> + <constant name="ARRAY_NORMAL" value="1"> + Normal array (array of [Vector3] normals). + </constant> + <constant name="ARRAY_TANGENT" value="2"> + Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. + </constant> + <constant name="ARRAY_COLOR" value="3"> + Vertex array (array of [Color] colors). + </constant> + <constant name="ARRAY_TEX_UV" value="4"> + UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + </constant> + <constant name="ARRAY_TEX_UV2" value="5"> + Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + </constant> + <constant name="ARRAY_BONES" value="6"> + Array of bone indices, as a float array. Each element in groups of 4 floats. + </constant> + <constant name="ARRAY_WEIGHTS" value="7"> + Array of bone weights, as a float array. Each element in groups of 4 floats. + </constant> + <constant name="ARRAY_INDEX" value="8"> + Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. + </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + Array format will include vertices (mandatory). + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + Array format will include normals + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + Array format will include tangents + </constant> + <constant name="ARRAY_FORMAT_COLOR" value="8"> + Array format will include a color array. + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + Array format will include UVs. + </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + Array format will include another set of UVs. + </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + Array format will include bone indices. + </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + Array format will include bone weights. + </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + Index array will be used. + </constant> + <constant name="PRIMITIVE_POINTS" value="0"> + Render array as points (one vertex equals one point). + </constant> + <constant name="PRIMITIVE_LINES" value="1"> + Render array as lines (every two vertices a line is created). + </constant> + <constant name="PRIMITIVE_LINE_STRIP" value="2"> + Render array as line strip. + </constant> + <constant name="PRIMITIVE_LINE_LOOP" value="3"> + Render array as line loop (like line strip, but closed). + </constant> + <constant name="PRIMITIVE_TRIANGLES" value="4"> + Render array as triangles (every three vertices a triangle is created). + </constant> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + Render array as triangle strips. + </constant> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + Render array as triangle fans. + </constant> + </constants> +</class> <class name="AtlasTexture" inherits="Texture" category="Core"> <brief_description> </brief_description> @@ -6005,7 +6247,7 @@ <description> </description> </method> - <method name="get_position"> + <method name="get_pos"> <return type="float"> </return> <description> @@ -6594,58 +6836,6 @@ </constant> </constants> </class> -<class name="BakedLight" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="bake"> - <description> - </description> - </method> - <method name="bake_lights"> - <description> - </description> - </method> - <method name="bake_radiance"> - <description> - </description> - </method> - <method name="debug_mesh_albedo"> - <description> - </description> - </method> - <method name="debug_mesh_light"> - <description> - </description> - </method> - <method name="get_cell_subdiv" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_cell_subdiv"> - <argument index="0" name="steps" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <members> - <member name="cell_subdiv" type="int" setter="set_cell_subdiv" getter="get_cell_subdiv" brief=""> - </member> - </members> - <signals> - <signal name="baked_light_changed"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> <class name="BaseButton" inherits="Control" category="Core"> <brief_description> Provides a base class for different kinds of buttons. @@ -6857,21 +7047,21 @@ <method name="Basis"> <return type="Basis"> </return> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="phi" type="float"> + <argument index="0" name="euler" type="Vector3"> </argument> <description> - Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. + Create a rotation matrix (in the XYZ convention: first Z, then Y, and X last) from the specified Euler angles, given in the vector format as (third, second, first). </description> </method> <method name="Basis"> <return type="Basis"> </return> - <argument index="0" name="euler" type="Vector3"> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> </argument> <description> - Create a rotation matrix (in the XYZ convention: first Z, then Y, and X last) from the specified Euler angles, given in the vector format as (third,second,first). + Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. </description> </method> <method name="Basis"> @@ -6940,38 +7130,32 @@ Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. </description> </method> - <method name="set_rotation_euler"> + <method name="scaled"> <return type="Basis"> </return> - <argument index="0" name="euler" type="Vector3"> + <argument index="0" name="scale" type="Vector3"> </argument> <description> - Changes only the rotation part of the [Basis] to a rotation corresponding to given Euler angles, while preserving the scaling part (as determined by get_scale). + Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. </description> </method> <method name="set_rotation_axis_angle"> - <return type="Basis"> - </return> <argument index="0" name="axis" type="Vector3"> </argument> - <argument index="1" name="phi" type="float"> + <argument index="1" name="angle" type="float"> </argument> <description> Changes only the rotation part of the [Basis] to a rotation around given axis by phi, while preserving the scaling part (as determined by get_scale). </description> </method> - <method name="scaled"> - <return type="Basis"> - </return> - <argument index="0" name="scale" type="Vector3"> + <method name="set_rotation_euler"> + <argument index="0" name="euler" type="Vector3"> </argument> <description> - Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. + Changes only the rotation part of the [Basis] to a rotation corresponding to given Euler angles, while preserving the scaling part (as determined by get_scale). </description> </method> <method name="set_scale"> - <return type="Basis"> - </return> <argument index="0" name="scale" type="Vector3"> </argument> <description> @@ -7055,7 +7239,7 @@ </description> </method> <method name="create_from_image_alpha"> - <argument index="0" name="image" type="Image"> + <argument index="0" name="image" type="Object"> </argument> <description> </description> @@ -7472,173 +7656,6 @@ </theme_item> </theme_items> </class> -<class name="ButtonArray" inherits="Control" category="Core"> - <brief_description> - Array of Buttons. - </brief_description> - <description> - Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.). - This is useful [i]e.g.[/i] for joypad-friendly interfaces and option menus. - </description> - <methods> - <method name="add_button"> - <argument index="0" name="text" type="String"> - </argument> - <argument index="1" name="tooltip" type="String" default=""""> - </argument> - <description> - Append a new button to the array, with the specified text and tooltip. - </description> - </method> - <method name="add_icon_button"> - <argument index="0" name="icon" type="Texture"> - </argument> - <argument index="1" name="text" type="String" default=""""> - </argument> - <argument index="2" name="tooltip" type="String" default=""""> - </argument> - <description> - Append a new button to the array, with the specified icon, text and tooltip. - </description> - </method> - <method name="clear"> - <description> - Remove all buttons from the array. - </description> - </method> - <method name="erase_button"> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - Remove the specified button in the array. - </description> - </method> - <method name="get_button_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of buttons in the array. - </description> - </method> - <method name="get_button_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - Return the icon of the specified button. - </description> - </method> - <method name="get_button_text" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - Return the text of the specified button. - </description> - </method> - <method name="get_button_tooltip" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - Return the tooltip of the specified button. - </description> - </method> - <method name="get_hovered" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the index of the currently hovered button in the array. - </description> - </method> - <method name="get_selected" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the index of the currently selected button in the array. - </description> - </method> - <method name="is_flat" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_button_icon"> - <argument index="0" name="button_idx" type="int"> - </argument> - <argument index="1" name="icon" type="Texture"> - </argument> - <description> - Set the icon of the specified button. - </description> - </method> - <method name="set_button_text"> - <argument index="0" name="button_idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - Define the text of the specified button. - </description> - </method> - <method name="set_button_tooltip"> - <argument index="0" name="button_idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - Define the tooltip of the specified button. - </description> - </method> - <method name="set_flat"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_selected"> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - Select a button in the array based on the given index. - </description> - </method> - </methods> - <members> - <member name="flat" type="bool" setter="set_flat" getter="is_flat" brief=""> - </member> - </members> - <signals> - <signal name="button_selected"> - <argument index="0" name="button_idx" type="int"> - </argument> - <description> - A button has been selected, its index is given as the argument. - </description> - </signal> - </signals> - <constants> - <constant name="ALIGN_BEGIN" value="0"> - Align buttons at the beginning. - </constant> - <constant name="ALIGN_CENTER" value="1"> - Align buttons in the middle. - </constant> - <constant name="ALIGN_END" value="2"> - Align buttons at the end. - </constant> - <constant name="ALIGN_FILL" value="3"> - Spread the buttons, but keep them small. - </constant> - <constant name="ALIGN_EXPAND_FILL" value="4"> - Spread the buttons, but expand them. - </constant> - </constants> -</class> <class name="ButtonGroup" inherits="Resource" category="Core"> <brief_description> Group of Buttons. @@ -8552,12 +8569,11 @@ </description> </method> <method name="make_input_local" qualifiers="const"> - <return type="InputEvent"> + <return type="Object"> </return> - <argument index="0" name="event" type="InputEvent"> + <argument index="0" name="event" type="Object"> </argument> <description> - Takes a global input event and convert to this item's coordinate system. </description> </method> <method name="set_as_toplevel"> @@ -8868,6 +8884,74 @@ <constants> </constants> </class> +<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_mid_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rings" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_mid_height"> + <argument index="0" name="mid_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height" brief=""> + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius" brief=""> + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="CapsuleShape" inherits="Shape" category="Core"> <brief_description> Capsule shape resource. @@ -9168,6 +9252,16 @@ <description> </description> </method> + <method name="class_get_property" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <description> + </description> + </method> <method name="class_get_property_list" qualifiers="const"> <return type="Array"> </return> @@ -9230,6 +9324,18 @@ <description> </description> </method> + <method name="class_set_property" qualifiers="const"> + <return type="Error"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> <method name="get_class_list" qualifiers="const"> <return type="PoolStringArray"> </return> @@ -9415,7 +9521,7 @@ <signal name="input_event"> <argument index="0" name="camera" type="Object"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="event" type="Object"> </argument> <argument index="2" name="click_pos" type="Vector3"> </argument> @@ -9454,7 +9560,6 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </method> <method name="add_shape"> @@ -9569,12 +9674,11 @@ <signal name="input_event"> <argument index="0" name="viewport" type="Object"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="event" type="Object"> </argument> <argument index="2" name="shape_idx" type="int"> </argument> <description> - This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </signal> <signal name="mouse_entered"> @@ -10183,120 +10287,6 @@ </theme_item> </theme_items> </class> -<class name="ColorRamp" inherits="Resource" category="Core"> - <brief_description> - Color interpolator node - </brief_description> - <description> - Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. - </description> - <methods> - <method name="add_point"> - <argument index="0" name="offset" type="float"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - Adds the specified color to the end of the ramp, with the specified offset - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="point" type="int"> - </argument> - <description> - Returns the color of the ramp color at index [i]point[/i] - </description> - </method> - <method name="get_colors" qualifiers="const"> - <return type="PoolColorArray"> - </return> - <description> - Returns the colors in the ramp - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="point" type="int"> - </argument> - <description> - Returns the offset of the ramp color at index [i]point[/i] - </description> - </method> - <method name="get_offsets" qualifiers="const"> - <return type="PoolRealArray"> - </return> - <description> - Returns the offsets for the colors in this ramp - </description> - </method> - <method name="get_point_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of colors in the ramp - </description> - </method> - <method name="interpolate"> - <return type="Color"> - </return> - <argument index="0" name="offset" type="float"> - </argument> - <description> - Returns the interpolated color specified by [i]offset[/i] - </description> - </method> - <method name="remove_point"> - <argument index="0" name="offset" type="int"> - </argument> - <description> - Removes the color at the index [i]offset[/i] - </description> - </method> - <method name="set_color"> - <argument index="0" name="point" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - Sets the color of the ramp color at index [i]point[/i] - </description> - </method> - <method name="set_colors"> - <argument index="0" name="colors" type="PoolColorArray"> - </argument> - <description> - Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. - </description> - </method> - <method name="set_offset"> - <argument index="0" name="point" type="int"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> - <description> - Sets the offset for the ramp color at index [i]point[/i] - </description> - </method> - <method name="set_offsets"> - <argument index="0" name="offsets" type="PoolRealArray"> - </argument> - <description> - Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. - </description> - </method> - </methods> - <members> - <member name="colors" type="float" setter="set_colors" getter="get_colors" brief=""> - </member> - <member name="offsets" type="float" setter="set_offsets" getter="get_offsets" brief=""> - </member> - </members> - <constants> - </constants> -</class> <class name="ColorRect" inherits="Control" category="Core"> <brief_description> </brief_description> @@ -10604,7 +10594,7 @@ Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container] derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. - Input device events ([InputEvent]) are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method MainLoop._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. + Input device events are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method MainLoop._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [method set_focus_mode]. Focus is lost when another control gains it, or the current focus owner is hidden. It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [method set_ignore_mouse] enables this function. Finally, controls are skinned according to a [Theme]. Setting a [Theme] on a control will propagate all the skinning down the tree. Optionally, skinning can be overridden per each control by calling the add_*_override functions, or from the editor. @@ -10621,7 +10611,6 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called when an input event reaches the control. </description> </method> <method name="accept_event"> @@ -10818,7 +10807,7 @@ <description> </description> </method> - <method name="get_global_pos" qualifiers="const"> + <method name="get_global_position" qualifiers="const"> <return type="Vector2"> </return> <description> @@ -11183,7 +11172,7 @@ Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. </description> </method> - <method name="set_global_pos"> + <method name="set_global_position"> <argument index="0" name="pos" type="Vector2"> </argument> <description> @@ -11322,7 +11311,7 @@ </member> <member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size" brief=""> </member> - <member name="rect_pos" type="Vector2" setter="set_pos" getter="get_pos" brief=""> + <member name="rect_position" type="Vector2" setter="set_position" getter="get_position" brief=""> </member> <member name="rect_rotation" type="float" setter="set_rotation_deg" getter="get_rotation_deg" brief=""> </member> @@ -11351,10 +11340,9 @@ </description> </signal> <signal name="gui_input"> - <argument index="0" name="ev" type="InputEvent"> + <argument index="0" name="ev" type="Object"> </argument> <description> - Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. </description> </signal> <signal name="minimum_size_changed"> @@ -11565,7 +11553,7 @@ </description> </method> <method name="get_side" qualifiers="const"> - <return type="Image"> + <return type="Object"> </return> <argument index="0" name="side" type="int"> </argument> @@ -11599,7 +11587,7 @@ <method name="set_side"> <argument index="0" name="side" type="int"> </argument> - <argument index="1" name="image" type="Image"> + <argument index="1" name="image" type="Object"> </argument> <description> </description> @@ -11640,6 +11628,74 @@ </constant> </constants> </class> +<class name="CubeMesh" inherits="PrimitiveMesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_size" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_size"> + <argument index="0" name="size" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_depth"> + <argument index="0" name="divisions" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_height"> + <argument index="0" name="divisions" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="size" type="Vector2" setter="set_size" getter="get_size" brief=""> + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + </member> + <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" brief=""> + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="Curve2D" inherits="Resource" category="Core"> <brief_description> Describes a Bezier curve in 2D space. @@ -12090,67 +12146,83 @@ <constants> </constants> </class> -<class name="DLLibrary" inherits="Resource" category="Core"> +<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> </brief_description> <description> </description> <methods> - <method name="get_platform_file" qualifiers="const"> - <return type="String"> + <method name="get_bottom_radius" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="platform" type="String"> - </argument> <description> </description> </method> - <method name="set_platform_file"> - <argument index="0" name="platform" type="String"> - </argument> - <argument index="1" name="file" type="String"> - </argument> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - </methods> - <constants> - </constants> -</class> -<class name="DLScript" inherits="Script" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_library" qualifiers="const"> - <return type="Object"> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_script_name" qualifiers="const"> - <return type="String"> + <method name="get_rings" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_library"> - <argument index="0" name="library" type="Object"> + <method name="get_top_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_bottom_radius"> + <argument index="0" name="radius" type="float"> </argument> <description> </description> </method> - <method name="set_script_name"> - <argument index="0" name="script_name" type="String"> + <method name="set_height"> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_top_radius"> + <argument index="0" name="radius" type="float"> </argument> <description> </description> </method> </methods> <members> - <member name="library" type="DLLibrary" setter="set_library" getter="get_library" brief=""> + <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" brief=""> </member> - <member name="script_name" type="String" setter="set_script_name" getter="get_script_name" brief=""> + <member name="height" type="float" setter="set_height" getter="get_height" brief=""> + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + </member> + <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius" brief=""> </member> </members> <constants> @@ -12345,8 +12417,6 @@ </method> </methods> <members> - <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param" brief=""> - </member> <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled" brief=""> </member> <member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" brief=""> @@ -13050,6 +13120,94 @@ <constants> </constants> </class> +<class name="EditorImportPlugin" inherits="Reference" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_import_options" qualifiers="virtual"> + <return type="Array"> + </return> + <argument index="0" name="preset" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_importer_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_option_visibility" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="option" type="String"> + </argument> + <argument index="1" name="options" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="get_preset_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_preset_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="preset" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_recognized_extensions" qualifiers="virtual"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_resource_type" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_save_extension" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_visible_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="import" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="source_file" type="String"> + </argument> + <argument index="1" name="save_path" type="String"> + </argument> + <argument index="2" name="options" type="Dictionary"> + </argument> + <argument index="3" name="r_platform_variants" type="Array"> + </argument> + <argument index="4" name="r_gen_files" type="Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> <class name="EditorPlugin" inherits="Node" category="Core"> <brief_description> Used by the editor to extend its functionality. @@ -13107,6 +13265,12 @@ During run-time, this will be a simple object with a script so this function does not need to be called then. </description> </method> + <method name="add_import_plugin"> + <argument index="0" name="arg0" type="Object"> + </argument> + <description> + </description> + </method> <method name="add_tool_submenu_item"> <argument index="0" name="name" type="String"> </argument> @@ -13156,7 +13320,6 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - If your plugin is active (because handles() returned true to the object), any input interaction with the 2D canvas editor will be first forwarded here. The canvas transform (containing zoom and offset to transform to edited world coordinates) is provided, but the input supplied is in untransformed coordinates to the canvas editor. Return true if you want to eat this event and not pass it to the canvas editor. </description> </method> <method name="forward_draw_over_canvas" qualifiers="virtual"> @@ -13176,9 +13339,6 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - This is a low level function for plugins that edit a given objet type derived from Spatial to capture the input of the viewport. The function is only being called if your object is being edited. - By using the [InputEvent] and the [Camera] arguments it's pretty easy to do raycasts into space using Camera functions. - Return true if you want to capture the input, otherwise false. </description> </method> <method name="get_base_control"> @@ -13327,6 +13487,12 @@ Remove a custom type added by [method EditorPlugin.add_custom_type] </description> </method> + <method name="remove_import_plugin"> + <argument index="0" name="arg0" type="Object"> + </argument> + <description> + </description> + </method> <method name="save_external_data" qualifiers="virtual"> <description> This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. @@ -13722,7 +13888,7 @@ </argument> <argument index="1" name="billboard" type="bool" default="false"> </argument> - <argument index="2" name="skeleton" type="RID" default="RID()"> + <argument index="2" name="skeleton" type="RID" default="[RID]"> </argument> <description> Add a mesh to the gizmo, this is used for visualization. Call this function during [method redraw]. @@ -13867,6 +14033,12 @@ "string" - major + minor + patch + status + revision in a single String </description> </method> + <method name="is_in_fixed_frame" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_iterations_per_second"> <argument index="0" name="iterations_per_second" type="int"> </argument> @@ -13932,7 +14104,7 @@ <description> </description> </method> - <method name="get_ambient_light_skybox_contribution" qualifiers="const"> + <method name="get_ambient_light_sky_contribution" qualifiers="const"> <return type="float"> </return> <description> @@ -14010,6 +14182,60 @@ <description> </description> </method> + <method name="get_fog_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_fog_depth_begin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_depth_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_max" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_min" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_sun_amount" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_sun_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_fog_transmit_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_glow_blend_mode" qualifiers="const"> <return type="int"> </return> @@ -14046,13 +14272,13 @@ <description> </description> </method> - <method name="get_skybox" qualifiers="const"> + <method name="get_sky" qualifiers="const"> <return type="CubeMap"> </return> <description> </description> </method> - <method name="get_skybox_scale" qualifiers="const"> + <method name="get_sky_scale" qualifiers="const"> <return type="float"> </return> <description> @@ -14100,19 +14326,19 @@ <description> </description> </method> - <method name="get_ssr_accel" qualifiers="const"> + <method name="get_ssr_depth_tolerance" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_ssr_depth_tolerance" qualifiers="const"> + <method name="get_ssr_fade_in" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_ssr_fade" qualifiers="const"> + <method name="get_ssr_fade_out" qualifiers="const"> <return type="float"> </return> <description> @@ -14190,6 +14416,30 @@ <description> </description> </method> + <method name="is_fog_depth_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_height_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_transmit_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_glow_bicubic_upscale_enabled" qualifiers="const"> <return type="bool"> </return> @@ -14234,12 +14484,6 @@ <description> </description> </method> - <method name="is_ssr_smooth" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_adjustment_brightness"> <argument index="0" name="brightness" type="float"> </argument> @@ -14282,7 +14526,7 @@ <description> </description> </method> - <method name="set_ambient_light_skybox_contribution"> + <method name="set_ambient_light_sky_contribution"> <argument index="0" name="energy" type="float"> </argument> <description> @@ -14372,6 +14616,84 @@ <description> </description> </method> + <method name="set_fog_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_begin"> + <argument index="0" name="distance" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_curve"> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_curve"> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_max"> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_min"> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_sun_amount"> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_sun_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_fog_transmit_curve"> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_transmit_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_glow_bicubic_upscale"> <argument index="0" name="enabled" type="bool"> </argument> @@ -14428,13 +14750,13 @@ <description> </description> </method> - <method name="set_skybox"> - <argument index="0" name="skybox" type="CubeMap"> + <method name="set_sky"> + <argument index="0" name="sky" type="CubeMap"> </argument> <description> </description> </method> - <method name="set_skybox_scale"> + <method name="set_sky_scale"> <argument index="0" name="scale" type="float"> </argument> <description> @@ -14494,12 +14816,6 @@ <description> </description> </method> - <method name="set_ssr_accel"> - <argument index="0" name="accel" type="float"> - </argument> - <description> - </description> - </method> <method name="set_ssr_depth_tolerance"> <argument index="0" name="depth_tolerance" type="float"> </argument> @@ -14512,26 +14828,26 @@ <description> </description> </method> - <method name="set_ssr_fade"> - <argument index="0" name="fade" type="float"> + <method name="set_ssr_fade_in"> + <argument index="0" name="fade_in" type="float"> </argument> <description> </description> </method> - <method name="set_ssr_max_steps"> - <argument index="0" name="max_steps" type="int"> + <method name="set_ssr_fade_out"> + <argument index="0" name="fade_out" type="float"> </argument> <description> </description> </method> - <method name="set_ssr_rough"> - <argument index="0" name="rough" type="bool"> + <method name="set_ssr_max_steps"> + <argument index="0" name="max_steps" type="int"> </argument> <description> </description> </method> - <method name="set_ssr_smooth"> - <argument index="0" name="smooth" type="bool"> + <method name="set_ssr_rough"> + <argument index="0" name="rough" type="bool"> </argument> <description> </description> @@ -14600,17 +14916,17 @@ </member> <member name="ambient_light_energy" type="float" setter="set_ambient_light_energy" getter="get_ambient_light_energy" brief=""> </member> - <member name="ambient_light_skybox_contribution" type="float" setter="set_ambient_light_skybox_contribution" getter="get_ambient_light_skybox_contribution" brief=""> + <member name="ambient_light_sky_contribution" type="float" setter="set_ambient_light_sky_contribution" getter="get_ambient_light_sky_contribution" brief=""> </member> - <member name="auto_expoure_enabled" type="bool" setter="set_tonemap_auto_exposure" getter="get_tonemap_auto_exposure" brief=""> + <member name="auto_exposure_enabled" type="bool" setter="set_tonemap_auto_exposure" getter="get_tonemap_auto_exposure" brief=""> </member> - <member name="auto_expoure_max_luma" type="float" setter="set_tonemap_auto_exposure_max" getter="get_tonemap_auto_exposure_max" brief=""> + <member name="auto_exposure_max_luma" type="float" setter="set_tonemap_auto_exposure_max" getter="get_tonemap_auto_exposure_max" brief=""> </member> - <member name="auto_expoure_min_luma" type="float" setter="set_tonemap_auto_exposure_min" getter="get_tonemap_auto_exposure_min" brief=""> + <member name="auto_exposure_min_luma" type="float" setter="set_tonemap_auto_exposure_min" getter="get_tonemap_auto_exposure_min" brief=""> </member> - <member name="auto_expoure_scale" type="float" setter="set_tonemap_auto_exposure_grey" getter="get_tonemap_auto_exposure_grey" brief=""> + <member name="auto_exposure_scale" type="float" setter="set_tonemap_auto_exposure_grey" getter="get_tonemap_auto_exposure_grey" brief=""> </member> - <member name="auto_expoure_speed" type="float" setter="set_tonemap_auto_exposure_speed" getter="get_tonemap_auto_exposure_speed" brief=""> + <member name="auto_exposure_speed" type="float" setter="set_tonemap_auto_exposure_speed" getter="get_tonemap_auto_exposure_speed" brief=""> </member> <member name="background_canvas_max_layer" type="int" setter="set_canvas_max_layer" getter="get_canvas_max_layer" brief=""> </member> @@ -14620,9 +14936,9 @@ </member> <member name="background_mode" type="int" setter="set_background" getter="get_background" brief=""> </member> - <member name="background_skybox" type="SkyBox" setter="set_skybox" getter="get_skybox" brief=""> + <member name="background_sky" type="Sky" setter="set_sky" getter="get_sky" brief=""> </member> - <member name="background_skybox_scale" type="float" setter="set_skybox_scale" getter="get_skybox_scale" brief=""> + <member name="background_sky_scale" type="float" setter="set_sky_scale" getter="get_sky_scale" brief=""> </member> <member name="dof_blur_far_amount" type="float" setter="set_dof_blur_far_amount" getter="get_dof_blur_far_amount" brief=""> </member> @@ -14644,6 +14960,32 @@ </member> <member name="dof_blur_near_transition" type="float" setter="set_dof_blur_near_transition" getter="get_dof_blur_near_transition" brief=""> </member> + <member name="fog_color" type="Color" setter="set_fog_color" getter="get_fog_color" brief=""> + </member> + <member name="fog_depth_begin" type="float" setter="set_fog_depth_begin" getter="get_fog_depth_begin" brief=""> + </member> + <member name="fog_depth_curve" type="float" setter="set_fog_depth_curve" getter="get_fog_depth_curve" brief=""> + </member> + <member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled" brief=""> + </member> + <member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled" brief=""> + </member> + <member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve" brief=""> + </member> + <member name="fog_height_enabled" type="bool" setter="set_fog_height_enabled" getter="is_fog_height_enabled" brief=""> + </member> + <member name="fog_height_max" type="float" setter="set_fog_height_max" getter="get_fog_height_max" brief=""> + </member> + <member name="fog_height_min" type="float" setter="set_fog_height_min" getter="get_fog_height_min" brief=""> + </member> + <member name="fog_sun_amount" type="float" setter="set_fog_sun_amount" getter="get_fog_sun_amount" brief=""> + </member> + <member name="fog_sun_color" type="Color" setter="set_fog_sun_color" getter="get_fog_sun_color" brief=""> + </member> + <member name="fog_transmit_curve" type="float" setter="set_fog_transmit_curve" getter="get_fog_transmit_curve" brief=""> + </member> + <member name="fog_transmit_enabled" type="bool" setter="set_fog_transmit_enabled" getter="is_fog_transmit_enabled" brief=""> + </member> <member name="glow_bicubic_upscale" type="bool" setter="set_glow_bicubic_upscale" getter="is_glow_bicubic_upscale_enabled" brief=""> </member> <member name="glow_blend_mode" type="int" setter="set_glow_blend_mode" getter="get_glow_blend_mode" brief=""> @@ -14674,15 +15016,13 @@ </member> <member name="glow_strength" type="float" setter="set_glow_strength" getter="get_glow_strength" brief=""> </member> - <member name="ss_reflections_accel" type="float" setter="set_ssr_accel" getter="get_ssr_accel" brief=""> - </member> - <member name="ss_reflections_accel_smooth" type="bool" setter="set_ssr_smooth" getter="is_ssr_smooth" brief=""> - </member> <member name="ss_reflections_depth_tolerance" type="float" setter="set_ssr_depth_tolerance" getter="get_ssr_depth_tolerance" brief=""> </member> <member name="ss_reflections_enabled" type="bool" setter="set_ssr_enabled" getter="is_ssr_enabled" brief=""> </member> - <member name="ss_reflections_fade" type="float" setter="set_ssr_fade" getter="get_ssr_fade" brief=""> + <member name="ss_reflections_fade_in" type="float" setter="set_ssr_fade_in" getter="get_ssr_fade_in" brief=""> + </member> + <member name="ss_reflections_fade_out" type="float" setter="set_ssr_fade_out" getter="get_ssr_fade_out" brief=""> </member> <member name="ss_reflections_max_steps" type="int" setter="set_ssr_max_steps" getter="get_ssr_max_steps" brief=""> </member> @@ -14720,7 +15060,7 @@ </constant> <constant name="BG_COLOR" value="1"> </constant> - <constant name="BG_SKYBOX" value="2"> + <constant name="BG_SKY" value="2"> </constant> <constant name="BG_CANVAS" value="3"> </constant> @@ -14913,7 +15253,7 @@ Get a [String] saved in Pascal format from the file. </description> </method> - <method name="get_position" qualifiers="const"> + <method name="get_pos" qualifiers="const"> <return type="int"> </return> <description> @@ -14959,6 +15299,19 @@ Open the file for writing or reading, depending on the flags. </description> </method> + <method name="open_compressed"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="compression_mode" type="int" default="0"> + </argument> + <description> + Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. + </description> + </method> <method name="open_encrypted"> <return type="int"> </return> @@ -15105,6 +15458,15 @@ <constant name="WRITE_READ" value="7"> Open the file for reading and writing. Create it if the file not exists and truncate if it exists. </constant> + <constant name="COMPRESSION_FASTLZ" value="0"> + Use the FastLZ compression method. + </constant> + <constant name="COMPRESSION_DEFLATE" value="1"> + Use the Deflate compression method. + </constant> + <constant name="COMPRESSION_ZSTD" value="2"> + Use the Zstd compression method. + </constant> </constants> </class> <class name="FileDialog" inherits="ConfirmationDialog" category="Core"> @@ -15433,8 +15795,11 @@ <method name="is_valid" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="extended_check" type="bool" default="false"> + </argument> <description> Check whether the function call may be resumed. This is not the case if the function state was already resumed. + If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. </description> </method> <method name="resume"> @@ -15466,6 +15831,78 @@ <constants> </constants> </class> +<class name="GDNativeLibrary" inherits="Resource" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_platform_file" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="platform" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_platform_file"> + <argument index="0" name="platform" type="String"> + </argument> + <argument index="1" name="file" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="GDNativeScript" inherits="Script" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_library" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_script_name" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="new" qualifiers="vararg"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="set_library"> + <argument index="0" name="library" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_script_name"> + <argument index="0" name="script_name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="library" type="GDNativeLibrary" setter="set_library" getter="get_library" brief=""> + </member> + <member name="script_name" type="String" setter="set_script_name" getter="get_script_name" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="GDScript" inherits="Script" category="Core"> <brief_description> </brief_description> @@ -16594,6 +17031,120 @@ <constants> </constants> </class> +<class name="Gradient" inherits="Resource" category="Core"> + <brief_description> + Color interpolator node + </brief_description> + <description> + Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. + </description> + <methods> + <method name="add_point"> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Adds the specified color to the end of the ramp, with the specified offset + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + Returns the color of the ramp color at index [i]point[/i] + </description> + </method> + <method name="get_colors" qualifiers="const"> + <return type="PoolColorArray"> + </return> + <description> + Returns the colors in the ramp + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + Returns the offset of the ramp color at index [i]point[/i] + </description> + </method> + <method name="get_offsets" qualifiers="const"> + <return type="PoolRealArray"> + </return> + <description> + Returns the offsets for the colors in this ramp + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of colors in the ramp + </description> + </method> + <method name="interpolate"> + <return type="Color"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + Returns the interpolated color specified by [i]offset[/i] + </description> + </method> + <method name="remove_point"> + <argument index="0" name="offset" type="int"> + </argument> + <description> + Removes the color at the index [i]offset[/i] + </description> + </method> + <method name="set_color"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Sets the color of the ramp color at index [i]point[/i] + </description> + </method> + <method name="set_colors"> + <argument index="0" name="colors" type="PoolColorArray"> + </argument> + <description> + Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. + </description> + </method> + <method name="set_offset"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + Sets the offset for the ramp color at index [i]point[/i] + </description> + </method> + <method name="set_offsets"> + <argument index="0" name="offsets" type="PoolRealArray"> + </argument> + <description> + Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. + </description> + </method> + </methods> + <members> + <member name="colors" type="float" setter="set_colors" getter="get_colors" brief=""> + </member> + <member name="offsets" type="float" setter="set_offsets" getter="get_offsets" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="GradientTexture" inherits="Texture" category="Core"> <brief_description> </brief_description> @@ -17615,40 +18166,6 @@ </theme_item> </theme_items> </class> -<class name="HButtonArray" inherits="ButtonArray" category="Core"> - <brief_description> - Horizontal button array. - </brief_description> - <description> - Horizontal button array. See [ButtonArray]. - </description> - <methods> - </methods> - <constants> - </constants> - <theme_items> - <theme_item name="button_separator" type="int"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="font" type="Font"> - </theme_item> - <theme_item name="font_color" type="Color"> - </theme_item> - <theme_item name="font_color_selected" type="Color"> - </theme_item> - <theme_item name="font_selected" type="Font"> - </theme_item> - <theme_item name="hover" type="StyleBox"> - </theme_item> - <theme_item name="icon_separator" type="int"> - </theme_item> - <theme_item name="normal" type="StyleBox"> - </theme_item> - <theme_item name="selected" type="StyleBox"> - </theme_item> - </theme_items> -</class> <class name="HScrollBar" inherits="ScrollBar" category="Core"> <brief_description> Horizontal scroll bar. @@ -17663,15 +18180,15 @@ <theme_items> <theme_item name="decrement" type="Texture"> </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="decrement_highlight" type="Texture"> </theme_item> <theme_item name="grabber" type="StyleBox"> </theme_item> - <theme_item name="grabber_hilite" type="StyleBox"> + <theme_item name="grabber_highlight" type="StyleBox"> </theme_item> <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="increment_highlight" type="Texture"> </theme_item> <theme_item name="scroll" type="StyleBox"> </theme_item> @@ -17713,9 +18230,9 @@ </theme_item> <theme_item name="grabber" type="Texture"> </theme_item> - <theme_item name="grabber_hilite" type="Texture"> + <theme_item name="grabber_highlight" type="Texture"> </theme_item> - <theme_item name="grabber_hilite" type="StyleBox"> + <theme_item name="grabber_highlight" type="StyleBox"> </theme_item> <theme_item name="slider" type="StyleBox"> </theme_item> @@ -18446,27 +18963,36 @@ <constants> </constants> </class> -<class name="Image" category="Built-In Types"> +<class name="Image" inherits="Resource" category="Core"> <brief_description> Image datatype. </brief_description> <description> - Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. + Native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. </description> <methods> - <method name="Image"> - <return type="Image"> - </return> - <argument index="0" name="width" type="int"> + <method name="blend_rect"> + <argument index="0" name="src" type="Image"> </argument> - <argument index="1" name="height" type="int"> + <argument index="1" name="src_rect" type="Rect2"> </argument> - <argument index="2" name="mipmaps" type="bool"> + <argument index="2" name="dst" type="Vector2"> </argument> - <argument index="3" name="format" type="int"> + <description> + Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + </description> + </method> + <method name="blend_rect_mask"> + <argument index="0" name="src" type="Image"> + </argument> + <argument index="1" name="mask" type="Image"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="dst" type="Vector2"> </argument> <description> - Create an empty image of a specific size and format. + Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] using a "mask" [Image] on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" [Image] and "mask" [Image] *must* have the same size (width and height) but they can have different formats </description> </method> <method name="blit_rect"> @@ -18474,137 +19000,276 @@ </argument> <argument index="1" name="src_rect" type="Rect2"> </argument> - <argument index="2" name="dest" type="Vector2" default="0"> + <argument index="2" name="dst" type="Vector2"> </argument> <description> Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". </description> </method> - <method name="compressed"> - <return type="Image"> + <method name="clear_mipmaps"> + <description> + </description> + </method> + <method name="compress"> + <return type="int"> </return> - <argument index="0" name="format" type="int" default="0"> + <argument index="0" name="mode" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="float"> </argument> <description> - Return a new compressed [Image] from this [Image] using one of [Image].COMPRESS_*. </description> </method> - <method name="converted"> - <return type="Image"> - </return> - <argument index="0" name="format" type="int" default="0"> + <method name="convert"> + <argument index="0" name="format" type="int"> </argument> <description> - Return a new [Image] from this [Image] with a different format. </description> </method> - <method name="decompressed"> - <return type="Image"> + <method name="copy_from"> + <argument index="0" name="src" type="Image"> + </argument> + <description> + </description> + </method> + <method name="create"> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="use_mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> + <method name="create_from_data"> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="use_mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <argument index="4" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="crop"> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="decompress"> + <return type="int"> </return> <description> - Return a new decompressed [Image]. </description> </method> - <method name="empty"> - <return type="bool"> + <method name="detect_alpha" qualifiers="const"> + <return type="int"> </return> <description> - Return whether this [Image] is empty(no data). + </description> + </method> + <method name="expand_x2_hq2x"> + <description> + </description> + </method> + <method name="fill"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Fills an [Image] with a specified [Color] </description> </method> <method name="fix_alpha_edges"> <description> </description> </method> - <method name="get_data"> + <method name="flip_x"> + <description> + </description> + </method> + <method name="flip_y"> + <description> + </description> + </method> + <method name="generate_mipmaps"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_data" qualifiers="const"> <return type="PoolByteArray"> </return> <description> Return the raw data of the [Image]. </description> </method> - <method name="get_format"> + <method name="get_format" qualifiers="const"> <return type="int"> </return> <description> Return the format of the [Image], one of [Image].FORMAT_*. </description> </method> - <method name="get_height"> + <method name="get_height" qualifiers="const"> <return type="int"> </return> <description> Return the height of the [Image]. </description> </method> - <method name="get_rect"> + <method name="get_mipmap_offset" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mipmap" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_pixel" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_rect" qualifiers="const"> <return type="Image"> </return> - <argument index="0" name="area" type="Rect2" default="0"> + <argument index="0" name="rect" type="Rect2"> </argument> <description> Return a new [Image] that is a copy of "area" in this [Image]. </description> </method> - <method name="get_used_rect"> + <method name="get_used_rect" qualifiers="const"> <return type="Rect2"> </return> <description> Return the area of this [Image] that is used/visibly colored/opaque. </description> </method> - <method name="get_width"> + <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> Return the width of the [Image]. </description> </method> + <method name="has_mipmaps" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_compressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_empty" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_invisible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="load"> <return type="int"> </return> - <argument index="0" name="path" type="String" default="0"> + <argument index="0" name="path" type="String"> </argument> <description> Load an [Image]. </description> </method> - <method name="resized"> - <return type="Image"> - </return> + <method name="lock"> + <description> + </description> + </method> + <method name="normalmap_to_xy"> + <description> + </description> + </method> + <method name="premultiply_alpha"> + <description> + </description> + </method> + <method name="put_pixel"> <argument index="0" name="x" type="int"> </argument> <argument index="1" name="y" type="int"> </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="resize"> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> <argument index="2" name="interpolation" type="int" default="1"> </argument> <description> - Return a new [Image] from this [Image] that is resized to size "x,y" using [Image].INTERPOLATE_*. </description> </method> - <method name="save_png"> + <method name="resize_to_po2"> + <argument index="0" name="square" type="bool" default=""false""> + </argument> + <description> + </description> + </method> + <method name="save_png" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="path" type="String" default="0"> + <argument index="0" name="path" type="String"> </argument> <description> Save this [Image] as a png. </description> </method> + <method name="shrink_x2"> + <description> + </description> + </method> + <method name="srgb_to_linear"> + <description> + </description> + </method> + <method name="unlock"> + <description> + </description> + </method> </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data" brief=""> + </member> + </members> <constants> - <constant name="COMPRESS_16BIT" value="0"> - </constant> - <constant name="COMPRESS_S3TC" value="1"> - </constant> - <constant name="COMPRESS_PVRTC2" value="2"> - </constant> - <constant name="COMPRESS_PVRTC4" value="3"> - </constant> - <constant name="COMPRESS_ETC" value="4"> - </constant> - <constant name="COMPRESS_ETC2" value="5"> - </constant> <constant name="FORMAT_L8" value="0"> </constant> <constant name="FORMAT_LA8" value="1"> @@ -18617,27 +19282,27 @@ </constant> <constant name="FORMAT_RGBA8" value="5"> </constant> - <constant name="FORMAT_RGB565" value="6"> + <constant name="FORMAT_RGBA4444" value="6"> </constant> - <constant name="FORMAT_RGBA4444" value="7"> + <constant name="FORMAT_RGBA5551" value="7"> </constant> - <constant name="FORMAT_RGBA5551" value="17"> + <constant name="FORMAT_RF" value="8"> </constant> - <constant name="FORMAT_RF" value="9"> + <constant name="FORMAT_RGF" value="9"> </constant> - <constant name="FORMAT_RGF" value="10"> + <constant name="FORMAT_RGBF" value="10"> </constant> - <constant name="FORMAT_RGBF" value="11"> + <constant name="FORMAT_RGBAF" value="11"> </constant> - <constant name="FORMAT_RGBAF" value="12"> + <constant name="FORMAT_RH" value="12"> </constant> - <constant name="FORMAT_RH" value="13"> + <constant name="FORMAT_RGH" value="13"> </constant> - <constant name="FORMAT_RGH" value="14"> + <constant name="FORMAT_RGBH" value="14"> </constant> - <constant name="FORMAT_RGBH" value="15"> + <constant name="FORMAT_RGBAH" value="15"> </constant> - <constant name="FORMAT_RGBAH" value="16"> + <constant name="FORMAT_RGBE9995" value="16"> </constant> <constant name="FORMAT_DXT1" value="17"> </constant> @@ -18645,9 +19310,9 @@ </constant> <constant name="FORMAT_DXT5" value="19"> </constant> - <constant name="FORMAT_ATI1" value="20"> + <constant name="FORMAT_RGTC_R" value="20"> </constant> - <constant name="FORMAT_ATI2" value="21"> + <constant name="FORMAT_RGTC_RG" value="21"> </constant> <constant name="FORMAT_BPTC_RGBA" value="22"> </constant> @@ -18687,59 +19352,27 @@ </constant> <constant name="INTERPOLATE_CUBIC" value="2"> </constant> - </constants> -</class> -<class name="ImageSkyBox" inherits="SkyBox" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_image_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="image" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_image_path"> - <argument index="0" name="image" type="int"> - </argument> - <argument index="1" name="path" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <members> - <member name="image_path_negative_x" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - <member name="image_path_negative_y" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - <member name="image_path_negative_z" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - <member name="image_path_positive_x" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - <member name="image_path_positive_y" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - <member name="image_path_positive_z" type="String" setter="set_image_path" getter="get_image_path" brief=""> - </member> - </members> - <constants> - <constant name="IMAGE_PATH_NEGATIVE_X" value="0"> + <constant name="ALPHA_NONE" value="0"> + </constant> + <constant name="ALPHA_BIT" value="1"> + </constant> + <constant name="ALPHA_BLEND" value="2"> </constant> - <constant name="IMAGE_PATH_POSITIVE_X" value="1"> + <constant name="COMPRESS_S3TC" value="0"> </constant> - <constant name="IMAGE_PATH_NEGATIVE_Y" value="2"> + <constant name="COMPRESS_PVRTC2" value="1"> </constant> - <constant name="IMAGE_PATH_POSITIVE_Y" value="3"> + <constant name="COMPRESS_PVRTC4" value="2"> </constant> - <constant name="IMAGE_PATH_NEGATIVE_Z" value="4"> + <constant name="COMPRESS_ETC" value="3"> </constant> - <constant name="IMAGE_PATH_POSITIVE_Z" value="5"> + <constant name="COMPRESS_ETC2" value="4"> </constant> - <constant name="IMAGE_PATH_MAX" value="6"> + <constant name="COMPRESS_SOURCE_GENERIC" value="0"> + </constant> + <constant name="COMPRESS_SOURCE_SRGB" value="1"> + </constant> + <constant name="COMPRESS_SOURCE_NORMAL" value="2"> </constant> </constants> </class> @@ -18775,10 +19408,6 @@ Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. </description> </method> - <method name="fix_alpha_edges"> - <description> - </description> - </method> <method name="get_data" qualifiers="const"> <return type="Image"> </return> @@ -18814,14 +19443,6 @@ Load an [ImageTexure]. </description> </method> - <method name="normal_to_xy"> - <description> - </description> - </method> - <method name="premultiply_alpha"> - <description> - </description> - </method> <method name="set_data"> <argument index="0" name="image" type="Image"> </argument> @@ -18849,10 +19470,6 @@ Set the storage type. One of [ImageTexture].STORAGE_*. </description> </method> - <method name="shrink_x2_and_keep_size"> - <description> - </description> - </method> </methods> <constants> <constant name="STORAGE_RAW" value="0"> @@ -19181,7 +19798,7 @@ </description> </method> <method name="parse_input_event"> - <argument index="0" name="event" type="InputEvent"> + <argument index="0" name="event" type="Object"> </argument> <description> </description> @@ -19275,15 +19892,39 @@ <constants> </constants> </class> -<class name="InputEvent" category="Built-In Types"> +<class name="InputEvent" inherits="Resource" category="Core"> <brief_description> - Built-in input event data. </brief_description> <description> - Built-in input event data. InputEvent is a built-in engine datatype, given that it's passed around and used so much. Depending on its type, the members contained can be different, so read the documentation well! Input events can also represent actions (editable from the project settings). </description> <methods> - <method name="is_action"> + <method name="action_match" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="as_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_device" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_action" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="action" type="String"> @@ -19292,7 +19933,7 @@ Return if this input event matches a pre-defined action, no matter the type. </description> </method> - <method name="is_action_pressed"> + <method name="is_action_pressed" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="action" type="String"> @@ -19301,7 +19942,7 @@ Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> - <method name="is_action_released"> + <method name="is_action_released" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="action" type="String"> @@ -19310,1045 +19951,627 @@ Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> - <method name="is_echo"> + <method name="is_action_type" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_echo" qualifiers="const"> <return type="bool"> </return> <description> Return if this input event is an echo event (only for events of type KEY, it will return false for other types). </description> </method> - <method name="is_pressed"> + <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> + <method name="set_device"> + <argument index="0" name="device" type="int"> </argument> - <argument index="1" name="pressed" type="bool"> + <description> + </description> + </method> + <method name="set_id"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="xformed_by" qualifiers="const"> + <return type="InputEvent"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <argument index="1" name="local_ofs" type="Vector2" default="Vector2(0, 0)"> </argument> <description> - Change the input event to an action event of the given name, regardless of its initial type, with the pressed status passed as argument. </description> </method> </methods> - <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> - </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventAction" category="Built-In Types"> +<class name="InputEventAction" inherits="InputEvent" category="Core"> <brief_description> - Built-in input event type for actions. + Input event type for actions. </brief_description> <description> - Input event type for actions that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> - </return> - <argument index="0" name="action" type="String"> - </argument> - <description> - Return if this input event matches a pre-defined action, i.e. always true for InputEventAction. - </description> - </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_action" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> - <return type="bool"> - </return> + <method name="set_action"> <argument index="0" name="action" type="String"> </argument> <description> - Return whether the given action is released (i.e. not pressed). </description> </method> - <method name="is_echo"> - <return type="bool"> - </return> - <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). - </description> - </method> - <method name="is_pressed"> - <return type="bool"> - </return> - <description> - Return if this input event is pressed. - </description> - </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> - </argument> - <argument index="1" name="pressed" type="bool"> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. + <member name="action" type="String" setter="set_action" getter="get_action" brief=""> </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" brief=""> </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventJoypadButton" category="Built-In Types"> +<class name="InputEventJoypadButton" inherits="InputEvent" category="Core"> <brief_description> - Built-in input event type for joypad button events. + Input event type for joypad button events. </brief_description> <description> - Input event type for joypad button events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_button_index" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_pressure" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> - <return type="bool"> - </return> - <argument index="0" name="action" type="String"> + <method name="set_button_index"> + <argument index="0" name="button_index" type="int"> </argument> <description> - Return whether the given action is released (i.e. not pressed). - </description> - </method> - <method name="is_echo"> - <return type="bool"> - </return> - <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). </description> </method> - <method name="is_pressed"> - <return type="bool"> - </return> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> + </argument> <description> - Return if this input event is pressed. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> - </argument> - <argument index="1" name="pressed" type="bool"> + <method name="set_pressure"> + <argument index="0" name="pressure" type="float"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="button_index" type="int" setter="" getter="" brief=""> + <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" brief=""> Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="pressed" type="bool" setter="" getter="" brief=""> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" brief=""> Pressed state of the joypad button. </member> - <member name="pressure" type="float" setter="" getter="" brief=""> + <member name="pressure" type="float" setter="set_pressure" getter="get_pressure" brief=""> Intensity of the button pressure, ranges from 0 to 1.0. </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventJoypadMotion" category="Built-In Types"> +<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core"> <brief_description> - Built-in input event type for joypad motion/axis events. + Input event type for joypad motion/axis events. </brief_description> <description> - Input event type for joypad motion/axis events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_axis" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_axis_value" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> - <return type="bool"> - </return> - <argument index="0" name="action" type="String"> + <method name="set_axis"> + <argument index="0" name="axis" type="int"> </argument> <description> - Return whether the given action is released (i.e. not pressed). - </description> - </method> - <method name="is_echo"> - <return type="bool"> - </return> - <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). - </description> - </method> - <method name="is_pressed"> - <return type="bool"> - </return> - <description> - Return if this input event is pressed. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> - </argument> - <argument index="1" name="pressed" type="bool"> + <method name="set_axis_value"> + <argument index="0" name="axis_value" type="float"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="axis" type="int" setter="" getter="" brief=""> + <member name="axis" type="int" setter="set_axis" getter="get_axis" brief=""> Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> - <member name="value" type="float" setter="" getter="" brief=""> + <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value" brief=""> Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventKey" category="Built-In Types"> +<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core"> <brief_description> - Built-in input event type for keyboard events. + Input event type for keyboard events. </brief_description> <description> - Input event type for keyboard events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_scancode" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_scancode_with_modifiers" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> - <return type="bool"> + <method name="get_unicode" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is released (i.e. not pressed). </description> </method> - <method name="is_echo"> - <return type="bool"> - </return> + <method name="set_echo"> + <argument index="0" name="echo" type="bool"> + </argument> <description> - Return if this input event is an echo event. </description> </method> - <method name="is_pressed"> - <return type="bool"> - </return> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> + </argument> <description> - Return if this input event is pressed. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> + <method name="set_scancode"> + <argument index="0" name="scancode" type="int"> </argument> - <argument index="1" name="pressed" type="bool"> + <description> + </description> + </method> + <method name="set_unicode"> + <argument index="0" name="unicode" type="int"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="alt" type="bool" setter="" getter="" brief=""> - State of the Alt modifier. - </member> - <member name="control" type="bool" setter="" getter="" brief=""> - State of the Ctrl modifier. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="echo" type="bool" setter="" getter="" brief=""> + <member name="echo" type="int" setter="set_echo" getter="is_echo" brief=""> Echo state of the key, i.e. whether it's a repeat event or not. </member> - <member name="meta" type="bool" setter="" getter="" brief=""> - State of the Meta modifier. - </member> - <member name="pressed" type="bool" setter="" getter="" brief=""> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" brief=""> Pressed state of the key. </member> - <member name="scancode" type="int" setter="" getter="" brief=""> + <member name="scancode" type="int" setter="set_scancode" getter="get_scancode" brief=""> Scancode of the key, one of the KEY_* constants in [@Global Scope]. </member> - <member name="shift" type="bool" setter="" getter="" brief=""> - State of the Shift modifier. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> - <member name="unicode" type="int" setter="" getter="" brief=""> + <member name="unicode" type="int" setter="set_unicode" getter="get_unicode" brief=""> Unicode identifier of the key (when relevant). </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventMouseButton" category="Built-In Types"> +<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core"> <brief_description> - Built-in input event type for mouse button events. + Base input event type for mouse events. </brief_description> <description> - Input event type for mouse button events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_button_mask" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_global_position" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> - <return type="bool"> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is released (i.e. not pressed). </description> </method> - <method name="is_echo"> - <return type="bool"> - </return> + <method name="set_button_mask"> + <argument index="0" name="button_mask" type="int"> + </argument> <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). </description> </method> - <method name="is_pressed"> - <return type="bool"> - </return> + <method name="set_global_position"> + <argument index="0" name="global_position" type="Vector2"> + </argument> <description> - Return if this input event is pressed. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> - </argument> - <argument index="1" name="pressed" type="bool"> + <method name="set_position"> + <argument index="0" name="position" type="Vector2"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="alt" type="bool" setter="" getter="" brief=""> - State of the Alt modifier. - </member> - <member name="button_index" type="int" setter="" getter="" brief=""> - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. - </member> - <member name="button_mask" type="int" setter="" getter="" brief=""> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" brief=""> Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. </member> - <member name="control" type="bool" setter="" getter="" brief=""> - State of the Control modifier. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="doubleclick" type="bool" setter="" getter="" brief=""> - Whether the event is a double-click. - </member> - <member name="global_pos" type="Vector2" setter="" getter="" brief=""> + <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" brief=""> Global position of the mouse click. </member> - <member name="global_x" type="float" setter="" getter="" brief=""> - Global X coordinate of the mouse click. - </member> - <member name="global_y" type="float" setter="" getter="" brief=""> - Global Y coordinate of the mouse click. - </member> - <member name="meta" type="bool" setter="" getter="" brief=""> - State of the Meta modifier. - </member> - <member name="pos" type="Vector2" setter="" getter="" brief=""> + <member name="position" type="Vector2" setter="set_position" getter="get_position" brief=""> Local position of the mouse click. </member> - <member name="pressed" type="bool" setter="" getter="" brief=""> - Pressed state of the mouse button. - </member> - <member name="shift" type="bool" setter="" getter="" brief=""> - State of the Shift modifier. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> - <member name="x" type="float" setter="" getter="" brief=""> - Local X coordinate of the mouse click. - </member> - <member name="y" type="float" setter="" getter="" brief=""> - Local Y coordinate of the mouse click. - </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventMouseMotion" category="Built-In Types"> +<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core"> <brief_description> - Built-in input event type for mouse motion events. + Input event type for mouse button events. </brief_description> <description> - Input event type for mouse motion events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_button_index" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_factor"> + <return type="float"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. Not relevant for MOUSE_MOTION events, always false. </description> </method> - <method name="is_action_released"> + <method name="is_doubleclick" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is released (i.e. not pressed). Not relevant for MOUSE_MOTION events, can be true or false depending on whether [method is_action] is true. </description> </method> - <method name="is_echo"> - <return type="bool"> - </return> + <method name="set_button_index"> + <argument index="0" name="button_index" type="int"> + </argument> <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). </description> </method> - <method name="is_pressed"> - <return type="bool"> - </return> + <method name="set_doubleclick"> + <argument index="0" name="doubleclick" type="bool"> + </argument> <description> - Return if this input event is pressed. Not relevant for MOUSE_MOTION events, always false. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> + <method name="set_factor"> + <argument index="0" name="factor" type="float"> </argument> - <argument index="1" name="pressed" type="bool"> + <description> + </description> + </method> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> </argument> <description> - Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="alt" type="bool" setter="" getter="" brief=""> - State of the Alt modifier. - </member> - <member name="button_mask" type="int" setter="" getter="" brief=""> - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. - </member> - <member name="control" type="bool" setter="" getter="" brief=""> - State of the Ctrl modifier. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="global_pos" type="Vector2" setter="" getter="" brief=""> - Global position of the mouse pointer. + <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" brief=""> + Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. </member> - <member name="global_x" type="float" setter="" getter="" brief=""> - Global X coordinate of the mouse pointer. + <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick" brief=""> + Whether the event is a double-click. </member> - <member name="global_y" type="float" setter="" getter="" brief=""> - Global Y coordinate of the mouse pointer. + <member name="factor" type="float" setter="set_factor" getter="get_factor" brief=""> </member> - <member name="meta" type="bool" setter="" getter="" brief=""> - State of the Meta modifier. - </member> - <member name="pos" type="Vector2" setter="" getter="" brief=""> - Local position of the mouse pointer. + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" brief=""> + Pressed state of the mouse button. </member> - <member name="relative_pos" type="Vector2" setter="" getter="" brief=""> + </members> + <constants> + </constants> +</class> +<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core"> + <brief_description> + Input event type for mouse motion events. + </brief_description> + <description> + </description> + <methods> + <method name="get_relative" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_speed" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_relative"> + <argument index="0" name="relative" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <argument index="0" name="speed" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="relative" type="Vector2" setter="set_relative" getter="get_relative" brief=""> Position of the mouse pointer relative to the previous mouse position. </member> - <member name="relative_x" type="float" setter="" getter="" brief=""> - X coordinate of the mouse pointer relative to the previous mouse position. - </member> - <member name="relative_y" type="float" setter="" getter="" brief=""> - Y coordinate of the mouse pointer relative to the previous mouse position. - </member> - <member name="shift" type="bool" setter="" getter="" brief=""> - State of the Shift modifier. - </member> - <member name="speed" type="Vector2" setter="" getter="" brief=""> + <member name="speed" type="Vector2" setter="set_speed" getter="get_speed" brief=""> Speed of the mouse pointer. </member> - <member name="speed_x" type="float" setter="" getter="" brief=""> - Speed of the mouse pointer on the X axis. - </member> - <member name="speed_y" type="float" setter="" getter="" brief=""> - Speed of the mouse pointer on the Y axis. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). - </member> - <member name="x" type="float" setter="" getter="" brief=""> - Local X coordinate of the mouse pointer. - </member> - <member name="y" type="float" setter="" getter="" brief=""> - Local Y coordinate of the mouse pointer. - </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventScreenDrag" category="Built-In Types"> +<class name="InputEventScreenDrag" inherits="InputEvent" category="Core"> <brief_description> - Built-in input event type for screen drag events. + Input event type for screen drag events. </brief_description> <description> - Input event type for screen drag events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> - <return type="bool"> + <method name="get_index" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. Not relevant for SCREEN_DRAG events, always false. </description> </method> - <method name="is_action_released"> - <return type="bool"> + <method name="get_relative" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is released (i.e. not pressed). Not relevant for SCREEN_DRAG events, can be true or false depending on whether [method is_action] is true. </description> </method> - <method name="is_echo"> - <return type="bool"> + <method name="get_speed" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). </description> </method> - <method name="is_pressed"> - <return type="bool"> - </return> + <method name="set_index"> + <argument index="0" name="index" type="int"> + </argument> <description> - Return if this input event is pressed. Not relevant for SCREEN_DRAG events, always false. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> + <method name="set_position"> + <argument index="0" name="position" type="Vector2"> </argument> - <argument index="1" name="pressed" type="bool"> + <description> + </description> + </method> + <method name="set_relative"> + <argument index="0" name="relative" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <argument index="0" name="speed" type="Vector2"> </argument> <description> - Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="index" type="int" setter="" getter="" brief=""> + <member name="index" type="int" setter="set_index" getter="get_index" brief=""> Drag event index in the case of a multi-drag event. </member> - <member name="pos" type="Vector2" setter="" getter="" brief=""> + <member name="position" type="Vector2" setter="set_position" getter="get_position" brief=""> Position of the drag event. </member> - <member name="relative_pos" type="Vector2" setter="" getter="" brief=""> + <member name="relative" type="Vector2" setter="set_relative" getter="get_relative" brief=""> Position of the drag event relative to its start position. </member> - <member name="relative_x" type="float" setter="" getter="" brief=""> - X coordinate of the drag event relative to its start position. - </member> - <member name="relative_y" type="float" setter="" getter="" brief=""> - Y coordinate of the drag event relative to its start position. - </member> - <member name="speed" type="Vector2" setter="" getter="" brief=""> + <member name="speed" type="Vector2" setter="set_speed" getter="get_speed" brief=""> Speed of the drag event. </member> - <member name="speed_x" type="float" setter="" getter="" brief=""> - Speed of the drag event on the X axis. - </member> - <member name="speed_y" type="float" setter="" getter="" brief=""> - Speed of the drag event on the Y axis. - </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). + </members> + <constants> + </constants> +</class> +<class name="InputEventScreenTouch" inherits="InputEvent" category="Core"> + <brief_description> + Input event type for screen touch events. + </brief_description> + <description> + </description> + <methods> + <method name="get_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_index"> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_position"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="index" type="int" setter="set_index" getter="get_index" brief=""> + Touch event index in the case of a multi-touch event. </member> - <member name="x" type="float" setter="" getter="" brief=""> - X coordinate of the drag event. + <member name="position" type="Vector2" setter="set_position" getter="get_position" brief=""> + Position of the touch event. </member> - <member name="y" type="float" setter="" getter="" brief=""> - Y coordinate of the drag event. + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" brief=""> + Pressed state of the touch event. </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> -<class name="InputEventScreenTouch" category="Built-In Types"> +<class name="InputEventWithModifiers" inherits="InputEvent" category="Core"> <brief_description> - Built-in input event type for touchscreen drag events. + Base class for input events with modifiers. </brief_description> <description> - Input event type for touchscreen drag events that extends the global [InputEvent] type. </description> <methods> - <method name="is_action"> + <method name="get_alt" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return if this input event matches a pre-defined action. </description> </method> - <method name="is_action_pressed"> + <method name="get_command" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is being pressed. </description> </method> - <method name="is_action_released"> + <method name="get_control" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="action" type="String"> - </argument> <description> - Return whether the given action is released (i.e. not pressed). </description> </method> - <method name="is_echo"> + <method name="get_metakey" qualifiers="const"> <return type="bool"> </return> <description> - Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). </description> </method> - <method name="is_pressed"> + <method name="get_shift" qualifiers="const"> <return type="bool"> </return> <description> - Return if this input event is pressed. </description> </method> - <method name="set_as_action"> - <argument index="0" name="action" type="String"> + <method name="set_alt"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_command"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_control"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_metakey"> + <argument index="0" name="enable" type="bool"> </argument> - <argument index="1" name="pressed" type="bool"> + <description> + </description> + </method> + <method name="set_shift"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Change the input event to an action event of the given name with the pressed status passed as argument. </description> </method> </methods> <members> - <member name="ID" type="int" setter="" getter="" brief=""> - Event identifier, positive integer increased at each new event. - </member> - <member name="device" type="int" setter="" getter="" brief=""> - Device identifier. - </member> - <member name="index" type="int" setter="" getter="" brief=""> - Touch event index in the case of a multi-touch event. - </member> - <member name="pos" type="Vector2" setter="" getter="" brief=""> - Position of the touch event. + <member name="alt" type="bool" setter="set_alt" getter="get_alt" brief=""> + State of the Alt modifier. </member> - <member name="pressed" type="bool" setter="" getter="" brief=""> - Pressed state of the touch event. + <member name="command" type="bool" setter="set_command" getter="get_command" brief=""> + State of the Command modifier. </member> - <member name="type" type="int" setter="" getter="" brief=""> - Type of event (one of the [InputEvent] constants). + <member name="control" type="bool" setter="set_control" getter="get_control" brief=""> + State of the Ctrl modifier. </member> - <member name="x" type="float" setter="" getter="" brief=""> - X coordinate of the touch event. + <member name="meta" type="bool" setter="set_metakey" getter="get_metakey" brief=""> + State of the Meta modifier. </member> - <member name="y" type="float" setter="" getter="" brief=""> - Y coordinate of the touch event. + <member name="shift" type="bool" setter="set_shift" getter="get_shift" brief=""> + State of the Shift modifier. </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key event. - </constant> - <constant name="MOUSE_MOTION" value="2"> - Mouse motion event. - </constant> - <constant name="MOUSE_BUTTON" value="3"> - Mouse button event. - </constant> - <constant name="JOYPAD_MOTION" value="4"> - Joypad motion event. - </constant> - <constant name="JOYPAD_BUTTON" value="5"> - Joypad button event. - </constant> - <constant name="SCREEN_TOUCH" value="6"> - Screen touch event. - </constant> - <constant name="SCREEN_DRAG" value="7"> - Screen drag event. - </constant> - <constant name="ACTION" value="8"> - Pre-defined action event (see [InputMap]). - </constant> </constants> </class> <class name="InputMap" inherits="Object" category="Core"> @@ -20356,13 +20579,12 @@ Singleton that manages actions. </brief_description> <description> - Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified. </description> <methods> <method name="action_add_event"> <argument index="0" name="action" type="String"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="event" type="Object"> </argument> <description> Add an [InputEvent] to an action. This [InputEvent] will trigger the action. @@ -20371,7 +20593,7 @@ <method name="action_erase_event"> <argument index="0" name="action" type="String"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="event" type="Object"> </argument> <description> Remove an [InputEvent] from an action. @@ -20382,7 +20604,7 @@ </return> <argument index="0" name="action" type="String"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="event" type="Object"> </argument> <description> Whether an action has an [InputEvent] associated with it. @@ -20405,7 +20627,7 @@ <method name="event_is_action" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="event" type="InputEvent"> + <argument index="0" name="event" type="Object"> </argument> <argument index="1" name="action" type="String"> </argument> @@ -20413,24 +20635,6 @@ Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. </description> </method> - <method name="get_action_from_id" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - Return the action corresponding to the identifier. - </description> - </method> - <method name="get_action_id" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="action" type="String"> - </argument> - <description> - Return the identifier of the given action. - </description> - </method> <method name="get_action_list"> <return type="Array"> </return> @@ -21254,6 +21458,18 @@ Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding]. </description> </method> + <method name="get_move_and_slide_colliders" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> @@ -21261,6 +21477,24 @@ Return whether the body is colliding with another. </description> </method> + <method name="is_move_and_slide_on_ceiling" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_move_and_slide_on_floor" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_move_and_slide_on_wall" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="move"> <return type="Vector3"> </return> @@ -21270,6 +21504,26 @@ Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> + <method name="move_and_slide"> + <return type="Vector3"> + </return> + <argument index="0" name="linear_velocity" type="Vector3"> + </argument> + <argument index="1" name="floor_normal" type="Vector3" default="Vector3(0, 0, 0)"> + </argument> + <argument index="2" name="ceil_normal" type="Vector3" default="Vector3(0, 0, 0)"> + </argument> + <argument index="3" name="slope_stop_min_velocity" type="float" default="5"> + </argument> + <argument index="4" name="max_bounces" type="int" default="4"> + </argument> + <argument index="5" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <argument index="6" name="ceil_max_angle" type="float" default="0.785398"> + </argument> + <description> + </description> + </method> <method name="move_to"> <return type="Vector3"> </return> @@ -21279,6 +21533,10 @@ Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> + <method name="revert_motion"> + <description> + </description> + </method> <method name="set_collide_with_character_bodies"> <argument index="0" name="enable" type="bool"> </argument> @@ -21963,9 +22221,7 @@ </constant> <constant name="PARAM_SHADOW_BIAS" value="12"> </constant> - <constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> - </constant> - <constant name="PARAM_MAX" value="14"> + <constant name="PARAM_MAX" value="13"> </constant> </constants> </class> @@ -22057,6 +22313,12 @@ <description> </description> </method> + <method name="get_shadow_smooth" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_texture" qualifiers="const"> <return type="Object"> </return> @@ -22214,6 +22476,12 @@ <description> </description> </method> + <method name="set_shadow_smooth"> + <argument index="0" name="smooth" type="float"> + </argument> + <description> + </description> + </method> <method name="set_texture"> <argument index="0" name="texture" type="Object"> </argument> @@ -22285,6 +22553,8 @@ </member> <member name="shadow_filter" type="float" setter="set_shadow_filter" getter="get_shadow_filter" brief=""> </member> + <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth" brief=""> + </member> <member name="shadow_gradient_length" type="float" setter="set_shadow_gradient_length" getter="get_shadow_gradient_length" brief=""> </member> <member name="shadow_item_cull_mask" type="int" setter="set_item_shadow_cull_mask" getter="get_item_shadow_cull_mask" brief=""> @@ -22533,7 +22803,7 @@ </member> <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" brief=""> </member> - <member name="gradient" type="ColorRamp" setter="set_gradient" getter="get_gradient" brief=""> + <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient" brief=""> </member> <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" brief=""> </member> @@ -23054,7 +23324,7 @@ </description> </method> <method name="input_event"> - <argument index="0" name="ev" type="InputEvent"> + <argument index="0" name="ev" type="Object"> </argument> <description> </description> @@ -23244,244 +23514,40 @@ Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. </description> <methods> - <method name="add_blend_shape"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="add_surface_from_arrays"> - <argument index="0" name="primitive" type="int"> - </argument> - <argument index="1" name="arrays" type="Array"> - </argument> - <argument index="2" name="blend_shapes" type="Array" default="Array()"> - </argument> - <argument index="3" name="compress_flags" type="int" default="97792"> - </argument> - <description> - Create a new surface ([method get_surface_count] that will become surf_idx for this. - Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). - (might be obsolete) The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed - </description> - </method> - <method name="center_geometry"> - <description> - </description> - </method> - <method name="clear_blend_shapes"> - <description> - </description> - </method> - <method name="get_blend_shape_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_blend_shape_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_blend_shape_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_custom_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - </description> - </method> - <method name="get_surface_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of surfaces that the [Mesh] holds. - </description> - </method> - <method name="regen_normalmaps"> - <description> - </description> - </method> - <method name="set_blend_shape_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_custom_aabb"> - <argument index="0" name="aabb" type="Rect3"> - </argument> - <description> - </description> - </method> - <method name="surface_get_array_index_len" qualifiers="const"> - <return type="int"> + <method name="create_convex_shape" qualifiers="const"> + <return type="Shape"> </return> - <argument index="0" name="surf_idx" type="int"> - </argument> <description> - Return the length in indices of the index array in the requested surface (see [method add_surface]). </description> </method> - <method name="surface_get_array_len" qualifiers="const"> - <return type="int"> + <method name="create_outline" qualifiers="const"> + <return type="ArrayMesh"> </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). - </description> - </method> - <method name="surface_get_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> + <argument index="0" name="margin" type="float"> </argument> <description> - Return the format mask of the requested surface (see [method add_surface]). </description> </method> - <method name="surface_get_material" qualifiers="const"> - <return type="Material"> + <method name="create_trimesh_shape" qualifiers="const"> + <return type="Shape"> </return> - <argument index="0" name="surf_idx" type="int"> - </argument> <description> - Return a [Material] in a given surface. Surface is rendered using this material. </description> </method> - <method name="surface_get_name" qualifiers="const"> - <return type="String"> + <method name="generate_triangle_mesh" qualifiers="const"> + <return type="TriangleMesh"> </return> - <argument index="0" name="surf_idx" type="int"> - </argument> <description> </description> </method> - <method name="surface_get_primitive_type" qualifiers="const"> - <return type="int"> + <method name="get_faces" qualifiers="const"> + <return type="PoolVector3Array"> </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - Return the primitive type of the requested surface (see [method add_surface]). - </description> - </method> - <method name="surface_remove"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. - </description> - </method> - <method name="surface_set_material"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="material" type="Material"> - </argument> - <description> - Set a [Material] for a given surface. Surface will be rendered using this material. - </description> - </method> - <method name="surface_set_name"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> <description> </description> </method> </methods> <constants> - <constant name="NO_INDEX_ARRAY" value="-1"> - Default value used for index_array_len when no indices are present. - </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4"> - Amount of weights/bone indices per vertex (always 4). - </constant> - <constant name="ARRAY_VERTEX" value="0"> - Vertex array (array of [Vector3] vertices). - </constant> - <constant name="ARRAY_NORMAL" value="1"> - Normal array (array of [Vector3] normals). - </constant> - <constant name="ARRAY_TANGENT" value="2"> - Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. - </constant> - <constant name="ARRAY_COLOR" value="3"> - Vertex array (array of [Color] colors). - </constant> - <constant name="ARRAY_TEX_UV" value="4"> - UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). - </constant> - <constant name="ARRAY_TEX_UV2" value="5"> - Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). - </constant> - <constant name="ARRAY_BONES" value="6"> - Array of bone indices, as a float array. Each element in groups of 4 floats. - </constant> - <constant name="ARRAY_WEIGHTS" value="7"> - Array of bone weights, as a float array. Each element in groups of 4 floats. - </constant> - <constant name="ARRAY_INDEX" value="8"> - Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. - </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> - Array format will include vertices (mandatory). - </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> - Array format will include normals - </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> - Array format will include tangents - </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> - Array format will include a color array. - </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> - Array format will include UVs. - </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> - Array format will include another set of UVs. - </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> - Array format will include bone indices. - </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> - Array format will include bone weights. - </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> - Index array will be used. - </constant> - <constant name="PRIMITIVE_POINTS" value="0"> - Render array as points (one vertex equals one point). - </constant> - <constant name="PRIMITIVE_LINES" value="1"> - Render array as lines (every two vertices a line is created). - </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> - Render array as line strip. - </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> - Render array as line loop (like line strip, but closed). - </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> - Render array as triangles (every three vertices a triangle is created). - </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> - Render array as triangle strips. - </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> - Render array as triangle fans. - </constant> </constants> </class> <class name="MeshDataTool" inherits="Reference" category="Core"> @@ -24611,6 +24677,8 @@ </constant> <constant name="COMPRESS_ZLIB" value="3"> </constant> + <constant name="COMPRESS_ZSTD" value="4"> + </constant> </constants> </class> <class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core"> @@ -24772,12 +24840,6 @@ </description> </method> <method name="Nil"> - <argument index="0" name="from" type="InputEvent"> - </argument> - <description> - </description> - </method> - <method name="Nil"> <argument index="0" name="from" type="Object"> </argument> <description> @@ -24796,12 +24858,6 @@ </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Image"> - </argument> - <description> - </description> - </method> - <method name="Nil"> <argument index="0" name="from" type="Color"> </argument> <description> @@ -25015,8 +25071,6 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called for every input event. - It has to be enabled with [method set_process_input] or the corresponding property in the inspector. </description> </method> <method name="_process" qualifiers="virtual"> @@ -25038,16 +25092,12 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called for every input event that has not already been handled by another node. - It has to be enabled with [method set_process_unhandled_input] or the corresponding property in the inspector. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> - <argument index="0" name="key_event" type="InputEvent"> + <argument index="0" name="event" type="InputEventKey"> </argument> <description> - Called for every [i]key[/i] input event that has not already been handled by another node. - It has to be enabled with [method set_process_unhandled_key_input] or the corresponding property in the inspector. </description> </method> <method name="add_child"> @@ -26131,7 +26181,7 @@ </argument> <argument index="2" name="blocking" type="bool"> </argument> - <argument index="3" name="output" type="Array" default="Array()"> + <argument index="3" name="output" type="Array" default="[]"> </argument> <description> Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. @@ -26264,7 +26314,7 @@ <return type="String"> </return> <description> - Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11" + Return the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". </description> </method> <method name="get_power_percent_left"> @@ -26645,7 +26695,7 @@ </description> </method> <method name="set_icon"> - <argument index="0" name="icon" type="Image"> + <argument index="0" name="icon" type="Object"> </argument> <description> </description> @@ -26895,7 +26945,7 @@ <method name="add_user_signal"> <argument index="0" name="signal" type="String"> </argument> - <argument index="1" name="arguments" type="Array" default="Array()"> + <argument index="1" name="arguments" type="Array" default="[]"> </argument> <description> Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). @@ -26941,7 +26991,7 @@ </argument> <argument index="2" name="method" type="String"> </argument> - <argument index="3" name="binds" type="Array" default="Array()"> + <argument index="3" name="binds" type="Array" default="[]"> </argument> <argument index="4" name="flags" type="int" default="0"> </argument> @@ -27184,7 +27234,7 @@ Persisting connections are saved when the object is serialized to file. </constant> <constant name="CONNECT_ONESHOT" value="4"> - One short connections disconnect themselves after emission. + One shot connections disconnect themselves after emission. </constant> </constants> </class> @@ -27253,7 +27303,7 @@ OmniDirectional Light, such as a light bulb or a candle. </brief_description> <description> - An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. + An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. </description> <methods> <method name="get_shadow_detail" qualifiers="const"> @@ -27622,7 +27672,7 @@ <method name="instance" qualifiers="const"> <return type="Node"> </return> - <argument index="0" name="edit_state" type="int" default="false"> + <argument index="0" name="edit_state" type="int" default="0"> </argument> <description> </description> @@ -27835,6 +27885,32 @@ </theme_item> </theme_items> </class> +<class name="PanoramaSky" inherits="Sky" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_panorama" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="set_panorama"> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="panorama" type="Texture" setter="set_panorama" getter="get_panorama" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="ParallaxBackground" inherits="CanvasLayer" category="Core"> <brief_description> A node used to create a parallax scrolling background. @@ -28105,14 +28181,14 @@ <description> </description> <methods> - <method name="get_amount" qualifiers="const"> - <return type="int"> + <method name="capture_aabb" qualifiers="const"> + <return type="Rect3"> </return> <description> </description> </method> - <method name="get_custom_aabb" qualifiers="const"> - <return type="Rect3"> + <method name="get_amount" qualifiers="const"> + <return type="int"> </return> <description> </description> @@ -28155,12 +28231,6 @@ <description> </description> </method> - <method name="get_gravity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> <method name="get_lifetime" qualifiers="const"> <return type="float"> </return> @@ -28185,12 +28255,24 @@ <description> </description> </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_use_local_coordinates" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> + <method name="get_visibility_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> <method name="is_emitting" qualifiers="const"> <return type="bool"> </return> @@ -28203,12 +28285,6 @@ <description> </description> </method> - <method name="set_custom_aabb"> - <argument index="0" name="aabb" type="Rect3"> - </argument> - <description> - </description> - </method> <method name="set_draw_order"> <argument index="0" name="order" type="int"> </argument> @@ -28253,12 +28329,6 @@ <description> </description> </method> - <method name="set_gravity"> - <argument index="0" name="accel_vec" type="Vector3"> - </argument> - <description> - </description> - </method> <method name="set_lifetime"> <argument index="0" name="secs" type="float"> </argument> @@ -28283,18 +28353,28 @@ <description> </description> </method> + <method name="set_speed_scale"> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> <method name="set_use_local_coordinates"> <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> + <method name="set_visibility_aabb"> + <argument index="0" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount" brief=""> </member> - <member name="custom_aabb" type="Rect3" setter="set_custom_aabb" getter="get_custom_aabb" brief=""> - </member> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" brief=""> </member> <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh" brief=""> @@ -28315,8 +28395,6 @@ </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta" brief=""> </member> - <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity" brief=""> - </member> <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime" brief=""> </member> <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" brief=""> @@ -28327,6 +28405,10 @@ </member> <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio" brief=""> </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" brief=""> + </member> + <member name="visibility_aabb" type="Rect3" setter="set_visibility_aabb" getter="get_visibility_aabb" brief=""> + </member> </members> <constants> <constant name="DRAW_ORDER_INDEX" value="0"> @@ -28383,13 +28465,6 @@ <description> </description> </method> - <method name="get_color_ramp" qualifiers="const"> - <return type="ColorRamp"> - </return> - <description> - Returns the [ColorRamp] used to tint each particle - </description> - </method> <method name="get_emission_half_extents" qualifiers="const"> <return type="Vector2"> </return> @@ -28423,6 +28498,13 @@ <description> </description> </method> + <method name="get_gradient" qualifiers="const"> + <return type="Gradient"> + </return> + <description> + Returns the [Gradient] used to tint each particle. + </description> + </method> <method name="get_h_frames" qualifiers="const"> <return type="int"> </return> @@ -28563,15 +28645,6 @@ <description> </description> </method> - <method name="set_color_ramp"> - <return type="ColorRamp"> - </return> - <argument index="0" name="color_ramp" type="Object"> - </argument> - <description> - Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes. - </description> - </method> <method name="set_emission_half_extents"> <argument index="0" name="extents" type="Vector2"> </argument> @@ -28624,6 +28697,15 @@ <description> </description> </method> + <method name="set_gradient"> + <return type="Gradient"> + </return> + <argument index="0" name="gradient" type="Object"> + </argument> + <description> + Sets the [Gradient] used to tint each particle. Particle will be tinted according to their lifetimes. + </description> + </method> <method name="set_h_frames"> <argument index="0" name="enable" type="int"> </argument> @@ -28705,7 +28787,7 @@ <members> <member name="color/color" type="Color" setter="set_color" getter="get_color" brief=""> </member> - <member name="color/color_ramp" type="ColorRamp" setter="set_color_ramp" getter="get_color_ramp" brief=""> + <member name="color/color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp" brief=""> </member> <member name="color_phases/count" type="int" setter="set_color_phases" getter="get_color_phases" brief=""> </member> @@ -28947,6 +29029,12 @@ <description> </description> </method> + <method name="get_gravity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> <method name="get_param" qualifiers="const"> <return type="float"> </return> @@ -29057,6 +29145,12 @@ <description> </description> </method> + <method name="set_gravity"> + <argument index="0" name="accel_vec" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="set_param"> <argument index="0" name="param" type="int"> </argument> @@ -29159,6 +29253,8 @@ </member> <member name="flatness" type="float" setter="set_flatness" getter="get_flatness" brief=""> </member> + <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity" brief=""> + </member> <member name="hue_variation" type="float" setter="set_param" getter="get_param" brief=""> </member> <member name="hue_variation_curve" type="CurveTexture" setter="set_param_texture" getter="get_param_texture" brief=""> @@ -29912,9 +30008,9 @@ </argument> <argument index="1" name="max_results" type="int" default="32"> </argument> - <argument index="2" name="exclude" type="Array" default="Array()"> + <argument index="2" name="exclude" type="Array" default="[]"> </argument> - <argument index="3" name="layer_mask" type="int" default="2147483647"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> <argument index="4" name="type_mask" type="int" default="15"> </argument> @@ -29935,9 +30031,9 @@ </argument> <argument index="1" name="to" type="Vector2"> </argument> - <argument index="2" name="exclude" type="Array" default="Array()"> + <argument index="2" name="exclude" type="Array" default="[]"> </argument> - <argument index="3" name="layer_mask" type="int" default="2147483647"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> <argument index="4" name="type_mask" type="int" default="15"> </argument> @@ -30120,22 +30216,22 @@ Remove a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> - <method name="area_set_collision_mask"> + <method name="area_set_collision_layer"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="layer" type="int"> </argument> <description> - Set which physics layers the area will monitor. + Assign the area to one or many physics layers. </description> </method> - <method name="area_set_layer_mask"> + <method name="area_set_collision_mask"> <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="mask" type="int"> </argument> <description> - Assign the area to one or many physics layers. + Set which physics layers the area will monitor. </description> </method> <method name="area_set_monitor_callback"> @@ -30283,31 +30379,31 @@ Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. </description> </method> - <method name="body_get_collision_mask" qualifiers="const"> + <method name="body_get_collision_layer" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body can collide with. + Return the physics layer or layers a body belongs to. </description> </method> - <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> + <method name="body_get_collision_mask" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> <description> - Return the continuous collision detection mode. + Return the physics layer or layers a body can collide with. </description> </method> - <method name="body_get_layer_mask" qualifiers="const"> + <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body belongs to. + Return the continuous collision detection mode. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -30471,6 +30567,15 @@ Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> + <method name="body_set_collision_layer"> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + Set the physics layer or layers a body belongs to. + </description> + </method> <method name="body_set_collision_mask"> <argument index="0" name="body" type="RID"> </argument> @@ -30503,15 +30608,6 @@ Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). </description> </method> - <method name="body_set_layer_mask"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="mask" type="int"> - </argument> - <description> - Set the physics layer or layers a body belongs to. - </description> - </method> <method name="body_set_max_contacts_reported"> <argument index="0" name="body" type="RID"> </argument> @@ -30658,7 +30754,7 @@ </argument> <argument index="2" name="body_a" type="RID"> </argument> - <argument index="3" name="body_b" type="RID" default="RID()"> + <argument index="3" name="body_b" type="RID" default="[RID]"> </argument> <description> Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -30711,9 +30807,9 @@ </argument> <argument index="2" name="anchor_b" type="Vector2"> </argument> - <argument index="3" name="body_a" type="RID" default="RID()"> + <argument index="3" name="body_a" type="RID" default="[RID]"> </argument> - <argument index="4" name="body_b" type="RID" default="RID()"> + <argument index="4" name="body_b" type="RID" default="[RID]"> </argument> <description> Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. @@ -30757,7 +30853,7 @@ </argument> <argument index="1" name="body_a" type="RID"> </argument> - <argument index="2" name="body_b" type="RID" default="RID()"> + <argument index="2" name="body_b" type="RID" default="[RID]"> </argument> <description> Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -31061,18 +31157,18 @@ This class contains the shape and other parameters for intersection/collision queries. </description> <methods> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> </return> <description> - Return the list of objects, or object [RID]s, that will be excluded from collisions. + Return the physics layer the shape belongs to. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> </return> <description> - Return the physics layer(s) the shape belongs to. + Return the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="get_margin" qualifiers="const"> @@ -31110,18 +31206,18 @@ Return the transform matrix of the shape queried. </description> </method> - <method name="set_exclude"> - <argument index="0" name="exclude" type="Array"> + <method name="set_collision_layer"> + <argument index="0" name="collision_layer" type="int"> </argument> <description> - Set the list of objects, or object [RID]s, that will be excluded from collisions. + Set the physics layer the shape belongs to. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> + <method name="set_exclude"> + <argument index="0" name="exclude" type="Array"> </argument> <description> - Set the physics layer(s) the shape belongs to. + Set the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="set_margin"> @@ -31437,7 +31533,7 @@ </description> </method> <method name="set_collision_layer"> - <argument index="0" name="mask" type="int"> + <argument index="0" name="layer" type="int"> </argument> <description> Set the physics layers this area is in. @@ -31767,9 +31863,9 @@ </argument> <argument index="1" name="to" type="Vector3"> </argument> - <argument index="2" name="exclude" type="Array" default="Array()"> + <argument index="2" name="exclude" type="Array" default="[]"> </argument> - <argument index="3" name="layer_mask" type="int" default="2147483647"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> <argument index="4" name="type_mask" type="int" default="15"> </argument> @@ -31922,15 +32018,15 @@ <description> </description> </method> - <method name="area_set_collision_mask"> + <method name="area_set_collision_layer"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="layer" type="int"> </argument> <description> </description> </method> - <method name="area_set_layer_mask"> + <method name="area_set_collision_mask"> <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="mask" type="int"> @@ -32078,23 +32174,19 @@ <description> </description> </method> - <method name="body_get_collision_mask" qualifiers="const"> + <method name="body_get_collision_layer" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="body_get_layer_mask" qualifiers="const"> + <method name="body_get_collision_mask" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> @@ -32232,6 +32324,14 @@ <description> </description> </method> + <method name="body_set_collision_layer"> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> <method name="body_set_collision_mask"> <argument index="0" name="body" type="RID"> </argument> @@ -32260,14 +32360,6 @@ <description> </description> </method> - <method name="body_set_layer_mask"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="mask" type="int"> - </argument> - <description> - </description> - </method> <method name="body_set_max_contacts_reported"> <argument index="0" name="body" type="RID"> </argument> @@ -32959,14 +33051,14 @@ <description> </description> <methods> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> </return> <description> </description> @@ -32995,14 +33087,14 @@ <description> </description> </method> - <method name="set_exclude"> - <argument index="0" name="exclude" type="Array"> + <method name="set_collision_layer"> + <argument index="0" name="collision_layer" type="int"> </argument> <description> </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> + <method name="set_exclude"> + <argument index="0" name="exclude" type="Array"> </argument> <description> </description> @@ -33313,6 +33405,60 @@ <constants> </constants> </class> +<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_depth"> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="size" type="Vector2" setter="set_size" getter="get_size" brief=""> + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="PlaneShape" inherits="Shape" category="Core"> <brief_description> </brief_description> @@ -33640,6 +33786,26 @@ Append an [PoolByteArray] at the end of this array. </description> </method> + <method name="compress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data compressed. The compression mode can be set using one of the COMPRESS_* constants of [File]. + </description> + </method> + <method name="decompress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="buffer_size" type="int"> + </argument> + <argument index="1" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data decompressed. The buffer_size should be set as the size of the uncompressed data. The compression mode can be set using one of the COMPRESS_* constants of [File]. + </description> + </method> <method name="get_string_from_ascii"> <return type="String"> </return> @@ -34900,195 +35066,455 @@ <constants> </constants> </class> -<class name="ProgressBar" inherits="Range" category="Core"> +<class name="PrimitiveMesh" inherits="Mesh" category="Core"> <brief_description> - General purpose progress bar. </brief_description> <description> - General purpose progress bar. Shows fill percentage from right to left. </description> <methods> - <method name="is_percent_visible" qualifiers="const"> - <return type="bool"> + <method name="get_material" qualifiers="const"> + <return type="Material"> </return> <description> </description> </method> - <method name="set_percent_visible"> - <argument index="0" name="visible" type="bool"> + <method name="set_material"> + <argument index="0" name="material" type="Material"> </argument> <description> </description> </method> </methods> <members> - <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible" brief=""> + <member name="material" type="Material" setter="set_material" getter="get_material" brief=""> </member> </members> <constants> </constants> - <theme_items> - <theme_item name="bg" type="StyleBox"> - </theme_item> - <theme_item name="fg" type="StyleBox"> - </theme_item> - <theme_item name="font" type="Font"> - </theme_item> - <theme_item name="font_color" type="Color"> - </theme_item> - <theme_item name="font_color_shadow" type="Color"> - </theme_item> - </theme_items> </class> -<class name="ProximityGroup" inherits="Spatial" category="Core"> +<class name="PrismMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> - General purpose proximity-detection node. </brief_description> <description> - General purpose proximity-detection node. </description> <methods> - <method name="broadcast"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="parameters" type="Variant"> - </argument> + <method name="get_left_to_right" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_grid_radius" qualifiers="const"> + <method name="get_size" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="set_dispatch_mode"> - <argument index="0" name="mode" type="int"> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_left_to_right"> + <argument index="0" name="left_to_right" type="float"> </argument> <description> </description> </method> - <method name="set_grid_radius"> - <argument index="0" name="radius" type="Vector3"> + <method name="set_size"> + <argument index="0" name="size" type="Vector3"> </argument> <description> </description> </method> - <method name="set_group_name"> - <argument index="0" name="name" type="String"> + <method name="set_subdivide_depth"> + <argument index="0" name="segments" type="int"> </argument> <description> </description> </method> - </methods> - <members> - <member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius" brief=""> - </member> - </members> - <signals> - <signal name="broadcast"> - <argument index="0" name="name" type="String"> + <method name="set_subdivide_height"> + <argument index="0" name="segments" type="int"> </argument> - <argument index="1" name="parameters" type="Array"> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <argument index="0" name="segments" type="int"> </argument> <description> </description> - </signal> - </signals> + </method> + </methods> + <members> + <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right" brief=""> + </member> + <member name="size" type="Vector2" setter="set_size" getter="get_size" brief=""> + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + </member> + <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" brief=""> + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + </member> + </members> <constants> </constants> </class> -<class name="Quad" inherits="GeometryInstance" category="Core"> +<class name="ProceduralSky" inherits="Sky" category="Core"> <brief_description> </brief_description> <description> </description> <methods> - <method name="get_axis" qualifiers="const"> - <return type="int"> + <method name="get_ground_bottom_color" qualifiers="const"> + <return type="Color"> </return> <description> </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> + <method name="get_ground_curve" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_ground_energy" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> + <method name="get_ground_horizon_color" qualifiers="const"> + <return type="Color"> </return> <description> </description> </method> - <method name="set_axis"> - <argument index="0" name="axis" type="int"> + <method name="get_sky_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sky_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sky_horizon_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sky_top_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sun_angle_max" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_angle_min" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sun_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_latitude" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_longitude" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_ground_bottom_color"> + <argument index="0" name="color" type="Color"> </argument> <description> </description> </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> + <method name="set_ground_curve"> + <argument index="0" name="curve" type="float"> </argument> <description> </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> + <method name="set_ground_energy"> + <argument index="0" name="energy" type="float"> </argument> <description> </description> </method> - <method name="set_size"> - <argument index="0" name="size" type="Vector2"> + <method name="set_ground_horizon_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sky_curve"> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sky_energy"> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sky_horizon_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sky_top_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sun_angle_max"> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_angle_min"> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sun_curve"> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_energy"> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_latitude"> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_longitude"> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture_size"> + <argument index="0" name="size" type="int"> </argument> <description> </description> </method> </methods> <members> - <member name="axis" type="int" setter="set_axis" getter="get_axis" brief=""> + <member name="ground_bottom_color" type="Color" setter="set_ground_bottom_color" getter="get_ground_bottom_color" brief=""> </member> - <member name="centered" type="bool" setter="set_centered" getter="is_centered" brief=""> + <member name="ground_curve" type="float" setter="set_ground_curve" getter="get_ground_curve" brief=""> </member> - <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" brief=""> + <member name="ground_energy" type="float" setter="set_ground_energy" getter="get_ground_energy" brief=""> </member> - <member name="size" type="Vector2" setter="set_size" getter="get_size" brief=""> + <member name="ground_horizon_color" type="Color" setter="set_ground_horizon_color" getter="get_ground_horizon_color" brief=""> + </member> + <member name="sky_curve" type="float" setter="set_sky_curve" getter="get_sky_curve" brief=""> + </member> + <member name="sky_energy" type="float" setter="set_sky_energy" getter="get_sky_energy" brief=""> + </member> + <member name="sky_horizon_color" type="Color" setter="set_sky_horizon_color" getter="get_sky_horizon_color" brief=""> + </member> + <member name="sky_top_color" type="Color" setter="set_sky_top_color" getter="get_sky_top_color" brief=""> + </member> + <member name="sun_angle_max" type="float" setter="set_sun_angle_max" getter="get_sun_angle_max" brief=""> + </member> + <member name="sun_angle_min" type="float" setter="set_sun_angle_min" getter="get_sun_angle_min" brief=""> + </member> + <member name="sun_color" type="Color" setter="set_sun_color" getter="get_sun_color" brief=""> + </member> + <member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve" brief=""> + </member> + <member name="sun_energy" type="float" setter="set_sun_energy" getter="get_sun_energy" brief=""> + </member> + <member name="sun_latitude" type="float" setter="set_sun_latitude" getter="get_sun_latitude" brief=""> + </member> + <member name="sun_longitude" type="float" setter="set_sun_longitude" getter="get_sun_longitude" brief=""> + </member> + <member name="texture_size" type="int" setter="set_texture_size" getter="get_texture_size" brief=""> </member> </members> <constants> </constants> </class> -<class name="QuadMesh" inherits="Mesh" category="Core"> +<class name="ProgressBar" inherits="Range" category="Core"> <brief_description> + General purpose progress bar. </brief_description> <description> + General purpose progress bar. Shows fill percentage from right to left. </description> <methods> - <method name="get_material" qualifiers="const"> - <return type="Material"> + <method name="is_percent_visible" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> + <method name="set_percent_visible"> + <argument index="0" name="visible" type="bool"> </argument> <description> </description> </method> </methods> <members> - <member name="material" type="Material" setter="set_material" getter="get_material" brief=""> + <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible" brief=""> + </member> + </members> + <constants> + </constants> + <theme_items> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="fg" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_shadow" type="Color"> + </theme_item> + </theme_items> +</class> +<class name="ProximityGroup" inherits="Spatial" category="Core"> + <brief_description> + General purpose proximity-detection node. + </brief_description> + <description> + General purpose proximity-detection node. + </description> + <methods> + <method name="broadcast"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="parameters" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="get_grid_radius" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="set_dispatch_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_grid_radius"> + <argument index="0" name="radius" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_group_name"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius" brief=""> </member> </members> + <signals> + <signal name="broadcast"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="parameters" type="Array"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> +<class name="QuadMesh" inherits="PrimitiveMesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> <constants> </constants> </class> @@ -35164,6 +35590,13 @@ Returns the inverse of the quaternion. </description> </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the quaternion is normalized or not. + </description> + </method> <method name="length"> <return type="float"> </return> @@ -35185,13 +35618,6 @@ Returns a copy of the quaternion, normalized to unit length. </description> </method> - <method name="is_normalized"> - <return type="bool"> - </return> - <description> - Returns whether the quaternion is normalized or not. - </description> - </method> <method name="slerp"> <return type="Quat"> </return> @@ -35478,6 +35904,13 @@ Returns the collision shape of the closest object the ray is pointing to. </description> </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the collision layer for this ray. + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3"> </return> @@ -35492,13 +35925,6 @@ Returns collision point. This point is in [b]global[/b] coordinate system. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the layer mask for this ray. - </description> - </method> <method name="get_type_mask" qualifiers="const"> <return type="int"> </return> @@ -35540,18 +35966,18 @@ Sets to which point ray should be casted. This point is in [b]local[/b] coordinate system. </description> </method> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="set_collision_layer"> + <argument index="0" name="layer" type="int"> </argument> <description> - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. + Set the mask to filter objects. Only objects with at least the same mask element set will be detected. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. </description> </method> <method name="set_type_mask"> @@ -35565,9 +35991,9 @@ <members> <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to" brief=""> </member> - <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" brief=""> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> </member> - <member name="layer_mask" type="int" setter="set_layer_mask" getter="get_layer_mask" brief=""> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" brief=""> </member> <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask" brief=""> </member> @@ -35633,6 +36059,13 @@ Returns the collision shape of the closest object the ray is pointing to. </description> </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the collision layer for this ray. + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> @@ -35654,13 +36087,6 @@ Returns whether this ray should hit your parent node, if it's a body. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the layer mask for this ray. - </description> - </method> <method name="get_type_mask" qualifiers="const"> <return type="int"> </return> @@ -35702,6 +36128,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> + <method name="set_collision_layer"> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + </description> + </method> <method name="set_enabled"> <argument index="0" name="enabled" type="bool"> </argument> @@ -35716,13 +36149,6 @@ Toggle whether this ray should hit your parent node, if it's a body. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. - </description> - </method> <method name="set_type_mask"> <argument index="0" name="mask" type="int"> </argument> @@ -35734,12 +36160,12 @@ <members> <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to" brief=""> </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> + </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" brief=""> </member> <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" brief=""> </member> - <member name="layer_mask" type="int" setter="set_layer_mask" getter="get_layer_mask" brief=""> - </member> <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask" brief=""> </member> </members> @@ -35879,6 +36305,30 @@ Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> + <method name="grow_individual"> + <return type="Rect2"> + </return> + <argument index="0" name="left" type="float"> + </argument> + <argument index="1" name="top" type="float"> + </argument> + <argument index="2" name="right" type="float"> + </argument> + <argument index="3" name=" bottom" type="float"> + </argument> + <description> + </description> + </method> + <method name="grow_margin"> + <return type="Rect2"> + </return> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="by" type="float"> + </argument> + <description> + </description> + </method> <method name="has_no_area"> <return type="bool"> </return> @@ -35918,8 +36368,7 @@ <member name="end" type="Vector2" setter="" getter="" brief=""> Ending corner. </member> - <member name="pos" type="Vector2" setter="" getter="" brief=""> - Position (starting corner). + <member name="position" type="Vector2" setter="" getter="" brief=""> </member> <member name="size" type="Vector2" setter="" getter="" brief=""> Size from position to end. @@ -36635,7 +37084,7 @@ <description> </description> </method> - <method name="duplicate"> + <method name="duplicate" qualifiers="const"> <return type="Object"> </return> <argument index="0" name="subresources" type="bool" default="false"> @@ -36778,7 +37227,7 @@ <return type="int"> </return> <description> - Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. + Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. </description> </method> <method name="wait"> @@ -39411,7 +39860,7 @@ </constant> </constants> </class> -<class name="SkyBox" inherits="Resource" category="Core"> +<class name="Sky" inherits="Resource" category="Core"> <brief_description> </brief_description> <description> @@ -39963,12 +40412,30 @@ <description> </description> </method> + <method name="get_depth_deep_parallax_max_layers" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_depth_deep_parallax_min_layers" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_depth_draw_mode" qualifiers="const"> <return type="int"> </return> <description> </description> </method> + <method name="get_depth_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_detail_blend_mode" qualifiers="const"> <return type="int"> </return> @@ -40015,19 +40482,13 @@ <description> </description> </method> - <method name="get_height_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_line_width" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_metalness" qualifiers="const"> + <method name="get_metallic" qualifiers="const"> <return type="float"> </return> <description> @@ -40069,12 +40530,6 @@ <description> </description> </method> - <method name="get_refraction_roughness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_rim" qualifiers="const"> <return type="float"> </return> @@ -40094,13 +40549,7 @@ </description> </method> <method name="get_specular" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_specular_mode" qualifiers="const"> - <return type="int"> + <return type="float"> </return> <description> </description> @@ -40143,6 +40592,12 @@ <description> </description> </method> + <method name="is_depth_deep_parallax_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_albedo"> <argument index="0" name="albedo" type="Color"> </argument> @@ -40185,12 +40640,36 @@ <description> </description> </method> + <method name="set_depth_deep_parallax"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_depth_deep_parallax_max_layers"> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_depth_deep_parallax_min_layers"> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> <method name="set_depth_draw_mode"> <argument index="0" name="depth_draw_mode" type="int"> </argument> <description> </description> </method> + <method name="set_depth_scale"> + <argument index="0" name="depth_scale" type="float"> + </argument> + <description> + </description> + </method> <method name="set_detail_blend_mode"> <argument index="0" name="detail_blend_mode" type="int"> </argument> @@ -40237,20 +40716,14 @@ <description> </description> </method> - <method name="set_height_scale"> - <argument index="0" name="height_scale" type="float"> - </argument> - <description> - </description> - </method> <method name="set_line_width"> <argument index="0" name="line_width" type="float"> </argument> <description> </description> </method> - <method name="set_metalness"> - <argument index="0" name="metalness" type="float"> + <method name="set_metallic"> + <argument index="0" name="metallic" type="float"> </argument> <description> </description> @@ -40291,12 +40764,6 @@ <description> </description> </method> - <method name="set_refraction_roughness"> - <argument index="0" name="refraction_roughness" type="float"> - </argument> - <description> - </description> - </method> <method name="set_rim"> <argument index="0" name="rim" type="float"> </argument> @@ -40316,13 +40783,7 @@ </description> </method> <method name="set_specular"> - <argument index="0" name="specular" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_specular_mode"> - <argument index="0" name="specular_mode" type="int"> + <argument index="0" name="specular" type="float"> </argument> <description> </description> @@ -40389,6 +40850,18 @@ </member> <member name="clearcoat_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> + <member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled" brief=""> + </member> + <member name="depth_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> + </member> + <member name="depth_max_layers" type="int" setter="set_depth_deep_parallax_max_layers" getter="get_depth_deep_parallax_max_layers" brief=""> + </member> + <member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers" brief=""> + </member> + <member name="depth_scale" type="float" setter="set_depth_scale" getter="get_depth_scale" brief=""> + </member> + <member name="depth_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> + </member> <member name="detail_albedo" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> <member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" brief=""> @@ -40419,11 +40892,11 @@ </member> <member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag" brief=""> </member> - <member name="height_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> + <member name="metallic_amount" type="float" setter="set_metallic" getter="get_metallic" brief=""> </member> - <member name="height_scale" type="float" setter="set_height_scale" getter="get_height_scale" brief=""> + <member name="metallic_specular" type="float" setter="set_specular" getter="get_specular" brief=""> </member> - <member name="height_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> + <member name="metallic_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> <member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> </member> @@ -40451,11 +40924,9 @@ </member> <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames" brief=""> </member> - <member name="refraction_displacement" type="float" setter="set_refraction" getter="get_refraction" brief=""> - </member> <member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> </member> - <member name="refraction_roughness" type="float" setter="set_refraction_roughness" getter="get_refraction_roughness" brief=""> + <member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction" brief=""> </member> <member name="refraction_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> @@ -40467,15 +40938,9 @@ </member> <member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint" brief=""> </member> - <member name="specular_color" type="Color" setter="set_specular" getter="get_specular" brief=""> - </member> - <member name="specular_metalness" type="float" setter="set_metalness" getter="get_metalness" brief=""> - </member> - <member name="specular_mode" type="int" setter="set_specular_mode" getter="get_specular_mode" brief=""> + <member name="roughness_amount" type="float" setter="set_roughness" getter="get_roughness" brief=""> </member> - <member name="specular_roughness" type="float" setter="set_roughness" getter="get_roughness" brief=""> - </member> - <member name="specular_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> + <member name="roughness_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> <member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> </member> @@ -40499,27 +40964,27 @@ <constants> <constant name="TEXTURE_ALBEDO" value="0"> </constant> - <constant name="TEXTURE_SPECULAR" value="1"> + <constant name="TEXTURE_METALLIC" value="1"> </constant> - <constant name="TEXTURE_EMISSION" value="2"> + <constant name="TEXTURE_ROUGHNESS" value="2"> </constant> - <constant name="TEXTURE_NORMAL" value="3"> + <constant name="TEXTURE_EMISSION" value="3"> </constant> - <constant name="TEXTURE_RIM" value="4"> + <constant name="TEXTURE_NORMAL" value="4"> </constant> - <constant name="TEXTURE_CLEARCOAT" value="5"> + <constant name="TEXTURE_RIM" value="5"> </constant> - <constant name="TEXTURE_FLOWMAP" value="6"> + <constant name="TEXTURE_CLEARCOAT" value="6"> </constant> - <constant name="TEXTURE_AMBIENT_OCCLUSION" value="7"> + <constant name="TEXTURE_FLOWMAP" value="7"> </constant> - <constant name="TEXTURE_HEIGHT" value="8"> + <constant name="TEXTURE_AMBIENT_OCCLUSION" value="8"> </constant> - <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="9"> + <constant name="TEXTURE_DEPTH" value="9"> </constant> - <constant name="TEXTURE_REFRACTION" value="10"> + <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10"> </constant> - <constant name="TEXTURE_REFRACTION_ROUGHNESS" value="11"> + <constant name="TEXTURE_REFRACTION" value="11"> </constant> <constant name="TEXTURE_DETAIL_MASK" value="12"> </constant> @@ -40547,7 +41012,7 @@ </constant> <constant name="FEATURE_AMBIENT_OCCLUSION" value="6"> </constant> - <constant name="FEATURE_HEIGHT_MAPPING" value="7"> + <constant name="FEATURE_DEPTH_MAPPING" value="7"> </constant> <constant name="FEATURE_SUBSURACE_SCATTERING" value="8"> </constant> @@ -40595,16 +41060,12 @@ </constant> <constant name="DIFFUSE_LAMBERT" value="0"> </constant> - <constant name="DIFFUSE_LAMBERT_WRAP" value="1"> + <constant name="DIFFUSE_HALF_LAMBERT" value="1"> </constant> <constant name="DIFFUSE_OREN_NAYAR" value="2"> </constant> <constant name="DIFFUSE_BURLEY" value="3"> </constant> - <constant name="SPECULAR_MODE_METALLIC" value="0"> - </constant> - <constant name="SPECULAR_MODE_SPECULAR" value="1"> - </constant> <constant name="BILLBOARD_DISABLED" value="0"> </constant> <constant name="BILLBOARD_ENABLED" value="1"> @@ -40615,6 +41076,88 @@ </constant> </constants> </class> +<class name="SphereMesh" inherits="PrimitiveMesh" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_is_hemisphere" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rings" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_height"> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_is_hemisphere"> + <argument index="0" name="is_hemisphere" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <argument index="0" name="radial_segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="height" type="float" setter="set_height" getter="get_height" brief=""> + </member> + <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere" brief=""> + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius" brief=""> + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="SphereShape" inherits="Shape" category="Core"> <brief_description> </brief_description> @@ -41840,7 +42383,7 @@ <description> </description> </method> - <method name="get_position" qualifiers="const"> + <method name="get_pos" qualifiers="const"> <return type="int"> </return> <description> @@ -42157,14 +42700,6 @@ <method name="String"> <return type="String"> </return> - <argument index="0" name="from" type="InputEvent"> - </argument> - <description> - </description> - </method> - <method name="String"> - <return type="String"> - </return> <argument index="0" name="from" type="Dictionary"> </argument> <description> @@ -43151,7 +43686,7 @@ </argument> <argument index="4" name="normals" type="PoolVector3Array" default="PoolVector3Array([])"> </argument> - <argument index="5" name="tangents" type="Array" default="Array()"> + <argument index="5" name="tangents" type="Array" default="[]"> </argument> <description> Insert a triangle fan made of array data into [Mesh] being constructed. @@ -43454,7 +43989,7 @@ <theme_items> <theme_item name="decrement" type="Texture"> </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="decrement_highlight" type="Texture"> </theme_item> <theme_item name="font" type="Font"> </theme_item> @@ -43468,7 +44003,7 @@ </theme_item> <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="increment_highlight" type="Texture"> </theme_item> <theme_item name="label_valign_bg" type="int"> </theme_item> @@ -43476,7 +44011,7 @@ </theme_item> <theme_item name="menu" type="Texture"> </theme_item> - <theme_item name="menu_hilite" type="Texture"> + <theme_item name="menu_highlight" type="Texture"> </theme_item> <theme_item name="panel" type="StyleBox"> </theme_item> @@ -43484,8 +44019,6 @@ </theme_item> <theme_item name="tab_bg" type="StyleBox"> </theme_item> - <theme_item name="tab_disabled" type="StyleBox"> - </theme_item> <theme_item name="tab_fg" type="StyleBox"> </theme_item> <theme_item name="top_margin" type="int"> @@ -43622,6 +44155,12 @@ <description> </description> </signal> + <signal name="tab_hover"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> </signals> <constants> <constant name="ALIGN_LEFT" value="0"> @@ -43646,7 +44185,7 @@ </theme_item> <theme_item name="decrement" type="Texture"> </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="decrement_highlight" type="Texture"> </theme_item> <theme_item name="font" type="Font"> </theme_item> @@ -43660,7 +44199,7 @@ </theme_item> <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="increment_highlight" type="Texture"> </theme_item> <theme_item name="label_valign_bg" type="int"> </theme_item> @@ -43670,26 +44209,12 @@ </theme_item> <theme_item name="tab_bg" type="StyleBox"> </theme_item> - <theme_item name="tab_disabled" type="StyleBox"> - </theme_item> <theme_item name="tab_fg" type="StyleBox"> </theme_item> <theme_item name="top_margin" type="int"> </theme_item> </theme_items> </class> -<class name="TestCube" inherits="GeometryInstance" category="Core"> - <brief_description> - A simple cube used for testing in 3D. - </brief_description> - <description> - The TestCube is a simple 2x2x2 cube with a basic texture. It can be used as a placeholder, to verify how the lighting looks, to test shaders, or any other task you may need a textured model to test with. - </description> - <methods> - </methods> - <constants> - </constants> -</class> <class name="TextEdit" inherits="Control" category="Core"> <brief_description> Multiline text editing control. @@ -43794,7 +44319,7 @@ <method name="cursor_set_column"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="adjust_viewport" type="bool" default="false"> + <argument index="1" name="adjust_viewport" type="bool" default="true"> </argument> <description> </description> @@ -43802,7 +44327,7 @@ <method name="cursor_set_line"> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="adjust_viewport" type="bool" default="false"> + <argument index="1" name="adjust_viewport" type="bool" default="true"> </argument> <description> </description> @@ -45015,6 +45540,14 @@ Return the collision layer. </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" qualifiers="const"> <return type="int"> </return> @@ -45022,6 +45555,14 @@ Return the collision mask. </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_collision_use_kinematic" qualifiers="const"> <return type="bool"> </return> @@ -45214,13 +45755,21 @@ </description> </method> <method name="set_collision_layer"> - <argument index="0" name="mask" type="int"> + <argument index="0" name="layer" type="int"> </argument> <description> Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. </description> </method> + <method name="set_collision_layer_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_collision_mask"> <argument index="0" name="mask" type="int"> </argument> @@ -45229,6 +45778,14 @@ Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. </description> </method> + <method name="set_collision_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_collision_use_kinematic"> <argument index="0" name="use_kinematic" type="bool"> </argument> @@ -45321,7 +45878,7 @@ </member> <member name="collision_friction" type="float" setter="set_collision_friction" getter="get_collision_friction" brief=""> </member> - <member name="collision_layers" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" brief=""> </member> @@ -46678,6 +47235,12 @@ Emitted when a cell is selected. </description> </signal> + <signal name="column_title_pressed"> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </signal> <signal name="custom_popup_edited"> <argument index="0" name="arrow_clicked" type="bool"> </argument> @@ -46704,6 +47267,10 @@ Emitted when an item is collapsed by a click on the folding arrow. </description> </signal> + <signal name="item_custom_button_pressed"> + <description> + </description> + </signal> <signal name="item_double_clicked"> <description> </description> @@ -46771,6 +47338,14 @@ </theme_item> <theme_item name="cursor_unfocused" type="StyleBox"> </theme_item> + <theme_item name="custom_button" type="StyleBox"> + </theme_item> + <theme_item name="custom_button_font_highlight" type="Color"> + </theme_item> + <theme_item name="custom_button_hover" type="StyleBox"> + </theme_item> + <theme_item name="custom_button_pressed" type="StyleBox"> + </theme_item> <theme_item name="draw_relationship_lines" type="int"> </theme_item> <theme_item name="drop_position_color" type="Color"> @@ -46836,6 +47411,8 @@ </argument> <argument index="3" name="disabled" type="bool" default="false"> </argument> + <argument index="4" name="tooltip" type="String" default=""""> + </argument> <description> </description> </method> @@ -47021,6 +47598,14 @@ <description> </description> </method> + <method name="is_custom_set_as_button" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> <method name="is_editable"> <return type="bool"> </return> @@ -47099,6 +47684,14 @@ <description> </description> </method> + <method name="set_custom_as_button"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_custom_bg_color"> <argument index="0" name="column" type="int"> </argument> @@ -47826,40 +48419,6 @@ do_property]. </theme_item> </theme_items> </class> -<class name="VButtonArray" inherits="ButtonArray" category="Core"> - <brief_description> - Vertical button array. - </brief_description> - <description> - Vertical button array. See [ButtonArray]. - </description> - <methods> - </methods> - <constants> - </constants> - <theme_items> - <theme_item name="button_separator" type="int"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="font" type="Font"> - </theme_item> - <theme_item name="font_color" type="Color"> - </theme_item> - <theme_item name="font_color_selected" type="Color"> - </theme_item> - <theme_item name="font_selected" type="Font"> - </theme_item> - <theme_item name="hover" type="StyleBox"> - </theme_item> - <theme_item name="icon_separator" type="int"> - </theme_item> - <theme_item name="normal" type="StyleBox"> - </theme_item> - <theme_item name="selected" type="StyleBox"> - </theme_item> - </theme_items> -</class> <class name="VScrollBar" inherits="ScrollBar" category="Core"> <brief_description> Vertical version of [ScrollBar], which goes from left (min) to right (max). @@ -47873,15 +48432,15 @@ do_property]. <theme_items> <theme_item name="decrement" type="Texture"> </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="decrement_highlight" type="Texture"> </theme_item> <theme_item name="grabber" type="StyleBox"> </theme_item> - <theme_item name="grabber_hilite" type="StyleBox"> + <theme_item name="grabber_highlight" type="StyleBox"> </theme_item> <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="increment_highlight" type="Texture"> </theme_item> <theme_item name="scroll" type="StyleBox"> </theme_item> @@ -47921,9 +48480,9 @@ do_property]. <theme_items> <theme_item name="grabber" type="Texture"> </theme_item> - <theme_item name="grabber_hilite" type="Texture"> + <theme_item name="grabber_highlight" type="Texture"> </theme_item> - <theme_item name="grabber_hilite" type="StyleBox"> + <theme_item name="grabber_highlight" type="StyleBox"> </theme_item> <theme_item name="slider" type="StyleBox"> </theme_item> @@ -48087,6 +48646,13 @@ do_property]. Remove the fractional part of x and y. </description> </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the vector is normalized or not. + </description> + </method> <method name="length"> <return type="float"> </return> @@ -48119,13 +48685,6 @@ do_property]. Returns a normalized vector to unit length. </description> </method> - <method name="is_normalized"> - <return type="bool"> - </return> - <description> - Returns whether the vector is normalized or not. - </description> - </method> <method name="reflect"> <return type="Vector2"> </return> @@ -48304,6 +48863,13 @@ do_property]. Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) </description> </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the vector is normalized or not. + </description> + </method> <method name="length"> <return type="float"> </return> @@ -48350,13 +48916,6 @@ do_property]. Return a copy of the normalized vector to unit length. This is the same as v / v.length(). </description> </method> - <method name="is_normalized"> - <return type="bool"> - </return> - <description> - Returns whether the vector is normalized or not. - </description> - </method> <method name="outer"> <return type="Basis"> </return> @@ -48560,6 +49119,12 @@ do_property]. <description> </description> </method> + <method name="get_roll_influence" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_suspension_max_force" qualifiers="const"> <return type="float"> </return> @@ -48584,6 +49149,12 @@ do_property]. <description> </description> </method> + <method name="is_in_contact" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_used_as_steering" qualifiers="const"> <return type="bool"> </return> @@ -48620,6 +49191,12 @@ do_property]. <description> </description> </method> + <method name="set_roll_influence"> + <argument index="0" name="roll_influence" type="float"> + </argument> + <description> + </description> + </method> <method name="set_suspension_max_force"> <argument index="0" name="length" type="float"> </argument> @@ -48678,6 +49255,8 @@ do_property]. </member> <member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length" brief=""> </member> + <member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence" brief=""> + </member> </members> <constants> </constants> @@ -48921,6 +49500,12 @@ do_property]. Return whether automatic clearing of the render target on each frame is enabled. </description> </method> + <method name="get_debug_draw" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_final_transform" qualifiers="const"> <return type="Transform2D"> </return> @@ -48962,11 +49547,12 @@ do_property]. Get whether picking for all physics objects inside the viewport is enabled. </description> </method> - <method name="get_screen_capture" qualifiers="const"> - <return type="Image"> + <method name="get_render_info"> + <return type="int"> </return> + <argument index="0" name="info" type="int"> + </argument> <description> - Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame until the right image is returned. </description> </method> <method name="get_shadow_atlas_quadrant_subdiv" qualifiers="const"> @@ -49011,6 +49597,12 @@ do_property]. Get when the viewport would be updated, will be one of the [code]UPDATE_*[/code] constants. </description> </method> + <method name="get_usage" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_vflip" qualifiers="const"> <return type="bool"> </return> @@ -49068,7 +49660,7 @@ do_property]. </description> </method> <method name="input"> - <argument index="0" name="local_event" type="InputEvent"> + <argument index="0" name="local_event" type="Object"> </argument> <description> </description> @@ -49121,11 +49713,6 @@ do_property]. Return whether the viewport is using a world separate from the parent viewport's world. </description> </method> - <method name="queue_screen_capture"> - <description> - Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. - </description> - </method> <method name="set_as_audio_listener"> <argument index="0" name="enable" type="bool"> </argument> @@ -49159,6 +49746,12 @@ do_property]. <description> </description> </method> + <method name="set_debug_draw"> + <argument index="0" name="debug_draw" type="int"> + </argument> + <description> + </description> + </method> <method name="set_disable_3d"> <argument index="0" name="disable" type="bool"> </argument> @@ -49251,6 +49844,12 @@ do_property]. Set when the render target would be updated, using the [code]UPDATE_*[/code] constants </description> </method> + <method name="set_usage"> + <argument index="0" name="usage" type="int"> + </argument> + <description> + </description> + </method> <method name="set_use_own_world"> <argument index="0" name="enable" type="bool"> </argument> @@ -49279,7 +49878,7 @@ do_property]. </description> </method> <method name="unhandled_input"> - <argument index="0" name="local_event" type="InputEvent"> + <argument index="0" name="local_event" type="Object"> </argument> <description> </description> @@ -49302,6 +49901,8 @@ do_property]. </member> <member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener" brief=""> </member> + <member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" brief=""> + </member> <member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled" brief=""> </member> <member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled" brief=""> @@ -49334,6 +49935,8 @@ do_property]. </member> <member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background" brief=""> </member> + <member name="usage" type="int" setter="set_usage" getter="get_usage" brief=""> + </member> <member name="world" type="World" setter="set_world" getter="get_world" brief=""> </member> </members> @@ -49372,6 +49975,28 @@ do_property]. </constant> <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7"> </constant> + <constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="RENDER_INFO_MAX" value="6"> + </constant> + <constant name="DEBUG_DRAW_DISABLED" value="0"> + </constant> + <constant name="DEBUG_DRAW_UNSHADED" value="1"> + </constant> + <constant name="DEBUG_DRAW_OVERDRAW" value="2"> + </constant> + <constant name="DEBUG_DRAW_WIREFRAME" value="3"> + </constant> <constant name="MSAA_DISABLED" value="0"> </constant> <constant name="MSAA_2X" value="1"> @@ -50503,24 +51128,12 @@ do_property]. <description> </description> <methods> - <method name="get_deconstruct_input_type" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_deconstruct_type" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_deconstruct_input_type"> - <argument index="0" name="input_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_deconstruct_type"> <argument index="0" name="type" type="int"> </argument> @@ -50531,8 +51144,6 @@ do_property]. <members> <member name="elem_cache" type="Array" setter="_set_elem_cache" getter="_get_elem_cache" brief=""> </member> - <member name="input_type" type="int" setter="set_deconstruct_input_type" getter="get_deconstruct_input_type" brief=""> - </member> <member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" brief=""> </member> </members> @@ -50893,16 +51504,6 @@ do_property]. <constants> </constants> </class> -<class name="VisualScriptInputFilter" inherits="VisualScriptNode" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> <class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core"> <brief_description> </brief_description> @@ -51163,12 +51764,6 @@ do_property]. <description> </description> </method> - <method name="get_event_type" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_property" qualifiers="const"> <return type="String"> </return> @@ -51205,12 +51800,6 @@ do_property]. <description> </description> </method> - <method name="set_event_type"> - <argument index="0" name="event_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_property"> <argument index="0" name="property" type="String"> </argument> @@ -51225,8 +51814,6 @@ do_property]. </member> <member name="property/basic_type" type="int" setter="set_basic_type" getter="get_basic_type" brief=""> </member> - <member name="property/event_type" type="int" setter="set_event_type" getter="get_event_type" brief=""> - </member> <member name="property/node_path" type="NodePath" setter="set_base_path" getter="get_base_path" brief=""> </member> <member name="property/property" type="String" setter="set_property" getter="get_property" brief=""> @@ -51281,12 +51868,6 @@ do_property]. <description> </description> </method> - <method name="get_event_type" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_property" qualifiers="const"> <return type="String"> </return> @@ -51323,12 +51904,6 @@ do_property]. <description> </description> </method> - <method name="set_event_type"> - <argument index="0" name="event_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_property"> <argument index="0" name="property" type="String"> </argument> @@ -51343,8 +51918,6 @@ do_property]. </member> <member name="property/basic_type" type="int" setter="set_basic_type" getter="get_basic_type" brief=""> </member> - <member name="property/event_type" type="int" setter="set_event_type" getter="get_event_type" brief=""> - </member> <member name="property/node_path" type="NodePath" setter="set_base_path" getter="get_base_path" brief=""> </member> <member name="property/property" type="String" setter="set_property" getter="get_property" brief=""> @@ -51767,7 +52340,7 @@ do_property]. <method name="texture_create_from_image"> <return type="RID"> </return> - <argument index="0" name="arg0" type="Image"> + <argument index="0" name="arg0" type="Object"> </argument> <argument index="1" name="arg1" type="int" default="7"> </argument> @@ -51890,7 +52463,7 @@ do_property]. </theme_item> <theme_item name="close_h_ofs" type="int"> </theme_item> - <theme_item name="close_hilite" type="Texture"> + <theme_item name="close_highlight" type="Texture"> </theme_item> <theme_item name="close_v_ofs" type="int"> </theme_item> @@ -51904,8 +52477,6 @@ do_property]. </theme_item> <theme_item name="title_height" type="int"> </theme_item> - <theme_item name="titlebar_height" type="int"> - </theme_item> </theme_items> </class> <class name="World" inherits="Resource" category="Core"> @@ -51928,6 +52499,12 @@ do_property]. <description> </description> </method> + <method name="get_fallback_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + </description> + </method> <method name="get_scenario" qualifiers="const"> <return type="RID"> </return> @@ -51946,10 +52523,18 @@ do_property]. <description> </description> </method> + <method name="set_fallback_environment"> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="environment" type="Environment" setter="set_environment" getter="get_environment" brief=""> </member> + <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment" brief=""> + </member> </members> <constants> </constants> @@ -51999,7 +52584,7 @@ do_property]. Sets environment properties for the entire scene </brief_description> <description> - The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). </description> <methods> <method name="get_environment" qualifiers="const"> @@ -52338,4 +52923,3 @@ do_property]. </constants> </class> </doc> - diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py index 1386e91ce1..1386e91ce1 100755..100644 --- a/doc/tools/doc_status.py +++ b/doc/tools/doc_status.py diff --git a/doc/tools/locales/es/LC_MESSAGES/makedocs.mo b/doc/tools/locales/es/LC_MESSAGES/makedocs.mo Binary files differdeleted file mode 100644 index 8d7ea2689e..0000000000 --- a/doc/tools/locales/es/LC_MESSAGES/makedocs.mo +++ /dev/null diff --git a/doc/tools/locales/es/LC_MESSAGES/makedocs.po b/doc/tools/locales/es/LC_MESSAGES/makedocs.po deleted file mode 100644 index 82115dd897..0000000000 --- a/doc/tools/locales/es/LC_MESSAGES/makedocs.po +++ /dev/null @@ -1,142 +0,0 @@ -# Translations template for PROJECT. -# Copyright (C) 2015 ORGANIZATION -# This file is distributed under the same license as the PROJECT project. -# FIRST AUTHOR <EMAIL@ADDRESS>, 2015. -# -msgid "" -msgstr "" -"Project-Id-Version: makedocs\n" -"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2015-10-07 11:47-0600\n" -"PO-Revision-Date: 2015-10-07 13:10-0600\n" -"Last-Translator: Jorge Araya Navarro <elcorreo@deshackra.com>\n" -"Language-Team: \n" -"Language: es\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.0\n" -"X-Generator: Poedit 1.8.4\n" -"Plural-Forms: nplurals=2; plural=(n != 1);\n" - -#: makedocs.py:74 -msgid "" -"\"<code>{gclass}</code>(Go to page of class {gclass})\":/class_{lkclass}" -msgstr "" -"\"<code>{gclass}</code>(Ir a la pagina de la clase {gclass})\":/" -"class_{lkclass}" - -#: makedocs.py:76 -msgid "" -"\"<code>{gclass}.{method}</code>(Go to page {gclass}, section {method})\":/" -"class_{lkclass}#{lkmethod}" -msgstr "" -"\"<code>{gclass}.{method}</code>(Ir a la pagina {gclass}, sección " -"{method})\":/class_{lkclass}#{lkmethod}" - -#: makedocs.py:79 -msgid "\"<code>{method}</code>(Jump to method {method})\":#{lkmethod}" -msgstr "\"<code>{method}</code>(Saltar al método {method})\":#{lkmethod}" - -#: makedocs.py:81 -msgid " \"{rtype}(Go to page of class {rtype})\":/class_{link} " -msgstr " \"{rtype}(Ir a la pagina de la clase {rtype})\":/class_{link} " - -#: makedocs.py:82 -msgid "" -"\"*{funcname}*(Jump to description for node {funcname})\":#{link} <b>(</b> " -msgstr "" -"\"*{funcname}*(Saltar a la descripción para el nodo {funcname})\":#{link} " -"<b>(</b> " - -#: makedocs.py:87 -msgid "h4. Inherits: " -msgstr "h4. Hereda de: " - -#: makedocs.py:232 -msgid "<doc>'s version attribute missing" -msgstr "El atributo version de <doc> no existe" - -#: makedocs.py:246 -msgid "|_. Index symbol |_. Class name |_. Index symbol |_. Class name |\n" -msgstr "" -"|_. Índice de símbolo |_. Nombre de la clase |_. Índice de símbolo |_. " -"Nombre de la clase |\n" - -#: makedocs.py:305 -msgid "" -"h4. Category: {}\n" -"\n" -msgstr "" -"h4. Categoría: {}\n" -"\n" - -#: makedocs.py:310 -msgid "" -"h2. Brief Description\n" -"\n" -msgstr "" -"h2. Descripción breve\n" -"\n" - -#: makedocs.py:312 -msgid "" -"\"read more\":#more\n" -"\n" -msgstr "" -"\"Leer más\":#more\n" -"\n" - -#: makedocs.py:317 -msgid "" -"\n" -"h3. Member Functions\n" -"\n" -msgstr "" -"\n" -"h3. Funciones miembro\n" -"\n" - -#: makedocs.py:323 -msgid "" -"\n" -"h3. Signals\n" -"\n" -msgstr "" -"\n" -"h3. Señales\n" -"\n" - -#: makedocs.py:331 -msgid "" -"\n" -"h3. Numeric Constants\n" -"\n" -msgstr "" -"\n" -"h3. Constantes numéricas\n" -"\n" - -#: makedocs.py:347 -msgid "" -"\n" -"h3(#more). Description\n" -"\n" -msgstr "" -"\n" -"h3(#more). Descripción\n" -"\n" - -#: makedocs.py:351 -msgid "_Nothing here, yet..._\n" -msgstr "_Aún nada por aquí..._\n" - -#: makedocs.py:355 -msgid "" -"\n" -"h3. Member Function Description\n" -"\n" -msgstr "" -"\n" -"h3. Descripción de las funciones miembro\n" -"\n" diff --git a/doc/tools/main.css b/doc/tools/main.css deleted file mode 100644 index 5eb3df2159..0000000000 --- a/doc/tools/main.css +++ /dev/null @@ -1,146 +0,0 @@ -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV, SPAN { - font-family: Arial, Geneva, Helvetica, sans-serif; -} - -a { - - text-decoration: none; - -} - -a:hover { - - text-decoration: underline; -} - -td.top_table { - - padding: 5px; -} - -div.method_doc { - - padding-bottom: 30px; -} - -div.method_description { - margin-left: 30px; -} - -list.inh_class_list { - margin-left: 30px; - -} - -div.inh_class_list { - margin-left: 30px; - -} - -div.method_doc div.method { - - font-size: 12pt; - font-weight: bold; -} - -span.funcdecl { - - color: #202060; -} - -span.funcdef { - - color: #202060; -} - - -span.qualifier { - - font-weight: bold; -} - - -span.symbol { - - /*font-weight: bold;*/ - color: #471870; -} - - -span.datatype { - - color: #6a1533; -} - -tr.category_title { - - background-color: #333333; -} -a.category_title { - font-weight: bold; - color: #FFFFFF; -} - -div.method_list { - - margin-left: 30px; -} - -div.constant_list { - - margin-left: 30px; -} - -div.member_list { - - margin-left: 30px; -} - -div.description { - - margin-left: 30px; -} - -div.class_description { - - margin-left: 30px; -} - -div.method_list li div { - - display: inline; -} - -div.member_list li div.member { - - display: inline; -} - -div.constant_list li div.constant { - - display: inline; -} - -span.member_description { - - font-style: italic; - color: grey; -} - -span.constant_description { - - font-style: italic; - color: grey; -} - -span.identifier { - - font-weight: bold; -} - - -table.class_table td { - - vertical-align: top; -} - diff --git a/doc/tools/makedocs.pot b/doc/tools/makedocs.pot deleted file mode 100644 index be3220f686..0000000000 --- a/doc/tools/makedocs.pot +++ /dev/null @@ -1,108 +0,0 @@ -# Translations template for PROJECT. -# Copyright (C) 2015 ORGANIZATION -# This file is distributed under the same license as the PROJECT project. -# FIRST AUTHOR <EMAIL@ADDRESS>, 2015. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: makedocs 0.1\n" -"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2015-10-07 11:47-0600\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" -"Language-Team: \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.0\n" -"X-Generator: Poedit 1.8.4\n" - -#: makedocs.py:74 -msgid "\"<code>{gclass}</code>(Go to page of class {gclass})\":/class_{lkclass}" -msgstr "" - -#: makedocs.py:76 -msgid "\"<code>{gclass}.{method}</code>(Go to page {gclass}, section {method})\":/class_{lkclass}#{lkmethod}" -msgstr "" - -#: makedocs.py:79 -msgid "\"<code>{method}</code>(Jump to method {method})\":#{lkmethod}" -msgstr "" - -#: makedocs.py:81 -msgid " \"{rtype}(Go to page of class {rtype})\":/class_{link} " -msgstr "" - -#: makedocs.py:82 -msgid "\"*{funcname}*(Jump to description for node {funcname})\":#{link} <b>(</b> " -msgstr "" - -#: makedocs.py:87 -msgid "h4. Inherits: " -msgstr "" - -#: makedocs.py:232 -msgid "<doc>'s version attribute missing" -msgstr "" - -#: makedocs.py:246 -msgid "|_. Index symbol |_. Class name |_. Index symbol |_. Class name |\n" -msgstr "" - -#: makedocs.py:305 -msgid "" -"h4. Category: {}\n" -"\n" -msgstr "" - -#: makedocs.py:310 -msgid "" -"h2. Brief Description\n" -"\n" -msgstr "" - -#: makedocs.py:312 -msgid "" -"\"read more\":#more\n" -"\n" -msgstr "" - -#: makedocs.py:317 -msgid "" -"\n" -"h3. Member Functions\n" -"\n" -msgstr "" - -#: makedocs.py:323 -msgid "" -"\n" -"h3. Signals\n" -"\n" -msgstr "" - -#: makedocs.py:331 -msgid "" -"\n" -"h3. Numeric Constants\n" -"\n" -msgstr "" - -#: makedocs.py:347 -msgid "" -"\n" -"h3(#more). Description\n" -"\n" -msgstr "" - -#: makedocs.py:351 -msgid "_Nothing here, yet..._\n" -msgstr "" - -#: makedocs.py:355 -msgid "" -"\n" -"h3. Member Function Description\n" -"\n" -msgstr "" diff --git a/doc/tools/makedocs.py b/doc/tools/makedocs.py deleted file mode 100644 index 9e0430bfbf..0000000000 --- a/doc/tools/makedocs.py +++ /dev/null @@ -1,383 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# -# makedocs.py: Generate documentation for Open Project Wiki -# Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. -# Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) -# Contributor: Jorge Araya Navarro <elcorreo@deshackra.com> -# - -# IMPORTANT NOTICE: -# If you are going to modify anything from this file, please be sure to follow -# the Style Guide for Python Code or often called "PEP8". To do this -# automagically just install autopep8: -# -# $ sudo pip3 install autopep8 -# -# and run: -# -# $ autopep8 makedocs.py -# -# Before committing your changes. Also be sure to delete any trailing -# whitespace you may left. -# -# TODO: -# * Refactor code. -# * Adapt this script for generating content in other markup formats like -# reStructuredText, Markdown, DokuWiki, etc. -# -# Also check other TODO entries in this script for more information on what is -# left to do. -import argparse -import gettext -import logging -import re -from itertools import zip_longest -from os import path, listdir -from xml.etree import ElementTree - - -# add an option to change the verbosity -logging.basicConfig(level=logging.INFO) - - -def getxmlfloc(): - """ Returns the supposed location of the XML file - """ - filepath = path.dirname(path.abspath(__file__)) - return path.join(filepath, "class_list.xml") - - -def langavailable(): - """ Return a list of languages available for translation - """ - filepath = path.join( - path.dirname(path.abspath(__file__)), "locales") - files = listdir(filepath) - choices = [x for x in files] - choices.insert(0, "none") - return choices - - -desc = "Generates documentation from a XML file to different markup languages" - -parser = argparse.ArgumentParser(description=desc) -parser.add_argument("--input", dest="xmlfp", default=getxmlfloc(), - help="Input XML file, default: {}".format(getxmlfloc())) -parser.add_argument("--output-dir", dest="outputdir", required=True, - help="Output directory for generated files") -parser.add_argument("--language", choices=langavailable(), default="none", - help=("Choose the language of translation" - " for the output files. Default is English (none). " - "Note: This is NOT for the documentation itself!")) -# TODO: add an option for outputting different markup formats - -args = parser.parse_args() -# Let's check if the file and output directory exists -if not path.isfile(args.xmlfp): - logging.critical("File not found: {}".format(args.xmlfp)) - exit(1) -elif not path.isdir(args.outputdir): - logging.critical("Path does not exist: {}".format(args.outputdir)) - exit(1) - -_ = gettext.gettext -if args.language != "none": - lang = gettext.translation(domain="makedocs", - localedir="locales", - languages=[args.language]) - lang.install() - - _ = lang.gettext - -# Strings -C_LINK = _("\"<code>{gclass}</code>(Go to page of class" - " {gclass})\":/class_{lkclass}") -MC_LINK = _("\"<code>{gclass}.{method}</code>(Go " - "to page {gclass}, section {method})\"" - ":/class_{lkclass}#{lkmethod}") -TM_JUMP = _("\"<code>{method}</code>(Jump to method" - " {method})\":#{lkmethod}") -GTC_LINK = _(" \"{rtype}(Go to page of class {rtype})\":/class_{link} ") -DFN_JUMP = _("\"*{funcname}*(Jump to description for" - " node {funcname})\":#{link} <b>(</b> ") -M_ARG_DEFAULT = C_LINK + " {name}={default}" -M_ARG = C_LINK + " {name}" - -OPENPROJ_INH = _("h4. Inherits: ") + C_LINK + "\n\n" - - -def tb(string): - """ Return a byte representation of a string - """ - return bytes(string, "UTF-8") - - -def sortkey(c): - """ Symbols are first, letters second - """ - if "_" == c.attrib["name"][0]: - return "A" - else: - return c.attrib["name"] - - -def toOP(text): - """ Convert commands in text to Open Project commands - """ - # TODO: Make this capture content between [command] ... [/command] - groups = re.finditer((r'\[html (?P<command>/?\w+/?)(\]| |=)?(\]| |=)?(?P<a' - 'rg>\w+)?(\]| |=)?(?P<value>"[^"]+")?/?\]'), text) - alignstr = "" - for group in groups: - gd = group.groupdict() - if gd["command"] == "br/": - text = text.replace(group.group(0), "\n\n", 1) - elif gd["command"] == "div": - if gd["value"] == '"center"': - alignstr = ("{display:block; margin-left:auto;" - " margin-right:auto;}") - elif gd["value"] == '"left"': - alignstr = "<" - elif gd["value"] == '"right"': - alignstr = ">" - text = text.replace(group.group(0), "\n\n", 1) - elif gd["command"] == "/div": - alignstr = "" - text = text.replace(group.group(0), "\n\n", 1) - elif gd["command"] == "img": - text = text.replace(group.group(0), "!{align}{src}!".format( - align=alignstr, src=gd["value"].strip('"')), 1) - elif gd["command"] == "b" or gd["command"] == "/b": - text = text.replace(group.group(0), "*", 1) - elif gd["command"] == "i" or gd["command"] == "/i": - text = text.replace(group.group(0), "_", 1) - elif gd["command"] == "u" or gd["command"] == "/u": - text = text.replace(group.group(0), "+", 1) - # Process other non-html commands - groups = re.finditer((r'\[method ((?P<class>[aA0-zZ9_]+)(?:\.))' - r'?(?P<method>[aA0-zZ9_]+)\]'), text) - for group in groups: - gd = group.groupdict() - if gd["class"]: - replacewith = (MC_LINK.format(gclass=gd["class"], - method=gd["method"], - lkclass=gd["class"].lower(), - lkmethod=gd["method"].lower())) - else: - # The method is located in the same wiki page - replacewith = (TM_JUMP.format(method=gd["method"], - lkmethod=gd["method"].lower())) - - text = text.replace(group.group(0), replacewith, 1) - # Finally, [Classes] are around brackets, make them direct links - groups = re.finditer(r'\[(?P<class>[az0-AZ0_]+)\]', text) - for group in groups: - gd = group.groupdict() - replacewith = (C_LINK. - format(gclass=gd["class"], - lkclass=gd["class"].lower())) - text = text.replace(group.group(0), replacewith, 1) - - return text + "\n\n" - - -def mkfn(node, is_signal=False): - """ Return a string containing a unsorted item for a function - """ - finalstr = "" - name = node.attrib["name"] - rtype = node.find("return") - if rtype: - rtype = rtype.attrib["type"] - else: - rtype = "void" - # write the return type and the function name first - finalstr += "* " - # return type - if not is_signal: - if rtype != "void": - finalstr += GTC_LINK.format( - rtype=rtype, - link=rtype.lower()) - else: - finalstr += " void " - - # function name - if not is_signal: - finalstr += DFN_JUMP.format( - funcname=name, - link=name.lower()) - else: - # Signals have no description - finalstr += "*{funcname}* <b>(</b>".format(funcname=name) - # loop for the arguments of the function, if any - args = [] - for arg in sorted( - node.iter(tag="argument"), - key=lambda a: int(a.attrib["index"])): - - ntype = arg.attrib["type"] - nname = arg.attrib["name"] - - if "default" in arg.attrib: - args.insert(-1, M_ARG_DEFAULT.format( - gclass=ntype, - lkclass=ntype.lower(), - name=nname, - default=arg.attrib["default"])) - else: - # No default value present - args.insert(-1, M_ARG.format(gclass=ntype, - lkclass=ntype.lower(), name=nname)) - # join the arguments together - finalstr += ", ".join(args) - # and, close the function with a ) - finalstr += " <b>)</b>" - # write the qualifier, if any - if "qualifiers" in node.attrib: - qualifier = node.attrib["qualifiers"] - finalstr += " " + qualifier - - finalstr += "\n" - - return finalstr - -# Let's begin -tree = ElementTree.parse(args.xmlfp) -root = tree.getroot() - -# Check version attribute exists in <doc> -if "version" not in root.attrib: - logging.critical(_("<doc>'s version attribute missing")) - exit(1) - -version = root.attrib["version"] -classes = sorted(root, key=sortkey) -# first column is always longer, second column of classes should be shorter -zclasses = zip_longest(classes[:int(len(classes) / 2 + 1)], - classes[int(len(classes) / 2 + 1):], - fillvalue="") - -# We write the class_list file and also each class file at once -with open(path.join(args.outputdir, "class_list.txt"), "wb") as fcl: - # Write header of table - fcl.write(tb("|^.\n")) - fcl.write(tb(_("|_. Index symbol |_. Class name " - "|_. Index symbol |_. Class name |\n"))) - fcl.write(tb("|-.\n")) - - indexletterl = "" - indexletterr = "" - for gdclassl, gdclassr in zclasses: - # write a row # - # write the index symbol column, left - if indexletterl != gdclassl.attrib["name"][0]: - indexletterl = gdclassl.attrib["name"][0] - fcl.write(tb("| *{}* |".format(indexletterl.upper()))) - else: - # empty cell - fcl.write(tb("| |")) - # write the class name column, left - fcl.write(tb(C_LINK.format( - gclass=gdclassl.attrib["name"], - lkclass=gdclassl.attrib["name"].lower()))) - - # write the index symbol column, right - if isinstance(gdclassr, ElementTree.Element): - if indexletterr != gdclassr.attrib["name"][0]: - indexletterr = gdclassr.attrib["name"][0] - fcl.write(tb("| *{}* |".format(indexletterr.upper()))) - else: - # empty cell - fcl.write(tb("| |")) - # We are dealing with an empty string - else: - # two empty cell - fcl.write(tb("| | |\n")) - # We won't get the name of the class since there is no ElementTree - # object for the right side of the tuple, so we iterate the next - # tuple instead - continue - - # write the class name column (if any), right - fcl.write(tb(C_LINK.format( - gclass=gdclassl.attrib["name"], - lkclass=gdclassl.attrib["name"].lower()) + "|\n")) - - # row written # - # now, let's write each class page for each class - for gdclass in [gdclassl, gdclassr]: - if not isinstance(gdclass, ElementTree.Element): - continue - - classname = gdclass.attrib["name"] - with open(path.join(args.outputdir, "{}.txt".format( - classname.lower())), "wb") as clsf: - # First level header with the name of the class - clsf.write(tb("h1. {}\n\n".format(classname))) - # lay the attributes - if "inherits" in gdclass.attrib: - inh = gdclass.attrib["inherits"].strip() - clsf.write(tb(OPENPROJ_INH.format(gclass=inh, - lkclass=inh.lower()))) - if "category" in gdclass.attrib: - clsf.write(tb(_("h4. Category: {}\n\n"). - format(gdclass.attrib["category"].strip()))) - # lay child nodes - briefd = gdclass.find("brief_description") - if briefd.text.strip(): - clsf.write(tb(_("h2. Brief Description\n\n"))) - clsf.write(tb(toOP(briefd.text.strip()) + - _("\"read more\":#more\n\n"))) - - # Write the list of member functions of this class - methods = gdclass.find("methods") - if methods and len(methods) > 0: - clsf.write(tb(_("\nh3. Member Functions\n\n"))) - for method in methods.iter(tag='method'): - clsf.write(tb(mkfn(method))) - - signals = gdclass.find("signals") - if signals and len(signals) > 0: - clsf.write(tb(_("\nh3. Signals\n\n"))) - for signal in signals.iter(tag='signal'): - clsf.write(tb(mkfn(signal, True))) - # TODO: <members> tag is necessary to process? it does not - # exists in class_list.xml file. - - consts = gdclass.find("constants") - if consts and len(consts) > 0: - clsf.write(tb(_("\nh3. Numeric Constants\n\n"))) - for const in sorted(consts, key=lambda k: - k.attrib["name"]): - if const.text.strip(): - clsf.write(tb("* *{name}* = *{value}* - {desc}\n". - format( - name=const.attrib["name"], - value=const.attrib["value"], - desc=const.text.strip()))) - else: - # Constant have no description - clsf.write(tb("* *{name}* = *{value}*\n". - format( - name=const.attrib["name"], - value=const.attrib["value"]))) - descrip = gdclass.find("description") - clsf.write(tb(_("\nh3(#more). Description\n\n"))) - if descrip.text: - clsf.write(tb(descrip.text.strip() + "\n")) - else: - clsf.write(tb(_("_Nothing here, yet..._\n"))) - - # and finally, the description for each method - if methods and len(methods) > 0: - clsf.write(tb(_("\nh3. Member Function Description\n\n"))) - for method in methods.iter(tag='method'): - clsf.write(tb("h4(#{n}). {name}\n\n".format( - n=method.attrib["name"].lower(), - name=method.attrib["name"]))) - clsf.write(tb(mkfn(method) + "\n")) - clsf.write(tb(toOP(method.find( - "description").text.strip()))) diff --git a/doc/tools/makedoku.py b/doc/tools/makedoku.py deleted file mode 100644 index ad3bfd791d..0000000000 --- a/doc/tools/makedoku.py +++ /dev/null @@ -1,499 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -import sys -import xml.etree.ElementTree as ET - -input_list = [] - - -for arg in sys.argv[1:]: - input_list.append(arg) - -if len(input_list) < 1: - print("usage: makedoku.py <classes.xml>") - sys.exit(0) - - -def validate_tag(elem, tag): - if (elem.tag != tag): - print("Tag mismatch, expected '" + tag + "', got " + elem.tag) - sys.exit(255) - - -class_names = [] -classes = {} - - -def make_class_list(class_list, columns): - - f = open("class_list.txt", "wb") - prev = 0 - col_max = len(class_list) / columns + 1 - print("col max is ", col_max) - col_count = 0 - row_count = 0 - last_initial = "" - fit_columns = [] - - for n in range(0, columns): - fit_columns += [[]] - - indexers = [] - last_initial = "" - - idx = 0 - for n in class_list: - col = idx / col_max - if (col >= columns): - col = columns - 1 - fit_columns[col] += [n] - idx += 1 - if (n[:1] != last_initial): - indexers += [n] - last_initial = n[:1] - - row_max = 0 - - for n in range(0, columns): - if (len(fit_columns[n]) > row_max): - row_max = len(fit_columns[n]) - - for r in range(0, row_max): - s = "|" - for c in range(0, columns): - if (r >= len(fit_columns[c])): - continue - - classname = fit_columns[c][r] - initial = classname[0] - if (classname in indexers): - s += "**" + initial + "**|" - else: - s += " |" - - s += "[[" + classname.lower() + "|" + classname + "]]|" - - s += "\n" - f.write(s) - - -def dokuize_text(txt): - - return txt - - -def dokuize_text(text): - pos = 0 - while(True): - pos = text.find("[", pos) - if (pos == -1): - break - - endq_pos = text.find("]", pos + 1) - if (endq_pos == -1): - break - - pre_text = text[:pos] - post_text = text[endq_pos + 1:] - tag_text = text[pos + 1:endq_pos] - - if (tag_text in class_names): - tag_text = "[[" + tag_text.lower() + "|" + tag_text + "]]" - else: # command - cmd = tag_text - space_pos = tag_text.find(" ") - if (cmd.find("html") == 0): - cmd = tag_text[:space_pos] - param = tag_text[space_pos + 1:] - tag_text = "<" + param + ">" - elif(cmd.find("method") == 0): - cmd = tag_text[:space_pos] - param = tag_text[space_pos + 1:] - - if (param.find(".") != -1): - class_param, method_param = param.split(".") - tag_text = "[[" + class_param.lower() + "#" + method_param + "|" + class_param + '.' + method_param + "]]" - else: - tag_text = "[[#" + param + "|" + param + "]]" - elif (cmd.find("image=") == 0): - tag_text = "{{" + cmd[6:] + "}}" - elif (cmd.find("url=") == 0): - tag_text = "[[" + cmd[4:] + "|" - elif (cmd == "/url"): - tag_text = "]]>" - elif (cmd == "center"): - tag_text = "" - elif (cmd == "/center"): - tag_text = "" - elif (cmd == "br"): - tag_text = "\\\\\n" - elif (cmd == "i" or cmd == "/i"): - tag_text = "//" - elif (cmd == "b" or cmd == "/b"): - tag_text = "**" - elif (cmd == "u" or cmd == "/u"): - tag_text = "__" - else: - tag_text = "[" + tag_text + "]" - - text = pre_text + tag_text + post_text - pos = len(pre_text) + len(tag_text) - - #tnode = ET.SubElement(parent,"div") - # tnode.text=text - return text - - -def make_type(t): - global class_names - if (t in class_names): - return "[[" + t.lower() + "|" + t + "]]" - return t - - -def make_method(f, name, m, declare, event=False): - - s = " * " - ret_type = "void" - args = list(m) - mdata = {} - mdata["argidx"] = [] - for a in args: - if (a.tag == "return"): - idx = -1 - elif (a.tag == "argument"): - idx = int(a.attrib["index"]) - else: - continue - - mdata["argidx"].append(idx) - mdata[idx] = a - - if (not event): - if (-1 in mdata["argidx"]): - s += make_type(mdata[-1].attrib["type"]) - else: - s += "void" - s += " " - - if (declare): - - # span.attrib["class"]="funcdecl" - # a=ET.SubElement(span,"a") - # a.attrib["name"]=name+"_"+m.attrib["name"] - # a.text=name+"::"+m.attrib["name"] - s += "**" + m.attrib["name"] + "**" - else: - s += "[[#" + m.attrib["name"] + "|" + m.attrib["name"] + "]]" - - s += "**(**" - argfound = False - for a in mdata["argidx"]: - arg = mdata[a] - if (a < 0): - continue - if (a > 0): - s += ", " - else: - s += " " - - s += make_type(arg.attrib["type"]) - if ("name" in arg.attrib): - s += " " + arg.attrib["name"] - else: - s += " arg" + str(a) - - if ("default" in arg.attrib): - s += "=" + arg.attrib["default"] - - argfound = True - - if (argfound): - s += " " - s += "**)**" - - if ("qualifiers" in m.attrib): - s += " " + m.attrib["qualifiers"] - - f.write(s + "\n") - - -def make_doku_class(node): - - name = node.attrib["name"] - - f = open(name.lower() + ".txt", "wb") - - f.write("====== " + name + " ======\n") - - if ("inherits" in node.attrib): - inh = node.attrib["inherits"].strip() - f.write("**Inherits:** [[" + inh.lower() + "|" + inh + "]]\\\\\n") - if ("category" in node.attrib): - f.write("**Category:** " + node.attrib["category"].strip() + "\\\\\n") - - briefd = node.find("brief_description") - if (briefd != None): - f.write("===== Brief Description ======\n") - f.write(dokuize_text(briefd.text.strip()) + "\n") - - methods = node.find("methods") - - if(methods != None and len(list(methods)) > 0): - f.write("===== Member Functions ======\n") - for m in list(methods): - make_method(f, node.attrib["name"], m, False) - - events = node.find("signals") - if(events != None and len(list(events)) > 0): - f.write("===== Signals ======\n") - for m in list(events): - make_method(f, node.attrib["name"], m, True, True) - - members = node.find("members") - - if(members != None and len(list(members)) > 0): - f.write("===== Member Variables ======\n") - - for c in list(members): - s = " * " - s += make_type(c.attrib["type"]) + " " - s += "**" + c.attrib["name"] + "**" - if (c.text.strip() != ""): - s += " - " + c.text.strip() - f.write(s + "\n") - - constants = node.find("constants") - if(constants != None and len(list(constants)) > 0): - f.write("===== Numeric Constants ======\n") - for c in list(constants): - s = " * " - s += "**" + c.attrib["name"] + "**" - if ("value" in c.attrib): - s += " = **" + c.attrib["value"] + "**" - if (c.text.strip() != ""): - s += " - " + c.text.strip() - f.write(s + "\n") - - descr = node.find("description") - if (descr != None and descr.text.strip() != ""): - f.write("===== Description ======\n") - f.write(dokuize_text(descr.text.strip()) + "\n") - - methods = node.find("methods") - - if(methods != None and len(list(methods)) > 0): - f.write("===== Member Function Description ======\n") - for m in list(methods): - - d = m.find("description") - if (d == None or d.text.strip() == ""): - continue - f.write("== " + m.attrib["name"] + " ==\n") - make_method(f, node.attrib["name"], m, False) - f.write("\\\\\n") - f.write(dokuize_text(d.text.strip())) - f.write("\n") - - """ - div=ET.Element("div") - div.attrib["class"]="class"; - - a=ET.SubElement(div,"a") - a.attrib["name"]=node.attrib["name"] - - h3=ET.SubElement(a,"h3") - h3.attrib["class"]="title class_title" - h3.text=node.attrib["name"] - - briefd = node.find("brief_description") - if (briefd!=None): - div2=ET.SubElement(div,"div") - div2.attrib["class"]="description class_description" - div2.text=briefd.text - - if ("inherits" in node.attrib): - ET.SubElement(div,"br") - - div2=ET.SubElement(div,"div") - div2.attrib["class"]="inheritance"; - - span=ET.SubElement(div2,"span") - span.text="Inherits: " - - make_type(node.attrib["inherits"],div2) - - if ("category" in node.attrib): - ET.SubElement(div,"br") - - div3=ET.SubElement(div,"div") - div3.attrib["class"]="category"; - - span=ET.SubElement(div3,"span") - span.attrib["class"]="category" - span.text="Category: " - - a = ET.SubElement(div3,"a") - a.attrib["class"]="category_ref" - a.text=node.attrib["category"] - catname=a.text - if (catname.rfind("/")!=-1): - catname=catname[catname.rfind("/"):] - catname="CATEGORY_"+catname - - if (single_page): - a.attrib["href"]="#"+catname - else: - a.attrib["href"]="category.html#"+catname - - - methods = node.find("methods") - - if(methods!=None and len(list(methods))>0): - - h4=ET.SubElement(div,"h4") - h4.text="Public Methods:" - - method_table=ET.SubElement(div,"table") - method_table.attrib["class"]="method_list"; - - for m in list(methods): -# li = ET.SubElement(div2, "li") - method_table.append( make_method_def(node.attrib["name"],m,False) ) - - events = node.find("signals") - - if(events!=None and len(list(events))>0): - h4=ET.SubElement(div,"h4") - h4.text="Events:" - - event_table=ET.SubElement(div,"table") - event_table.attrib["class"]="method_list"; - - for m in list(events): -# li = ET.SubElement(div2, "li") - event_table.append( make_method_def(node.attrib["name"],m,False,True) ) - - - members = node.find("members") - if(members!=None and len(list(members))>0): - - h4=ET.SubElement(div,"h4") - h4.text="Public Variables:" - div2=ET.SubElement(div,"div") - div2.attrib["class"]="member_list"; - - for c in list(members): - - li = ET.SubElement(div2, "li") - div3=ET.SubElement(li,"div") - div3.attrib["class"]="member"; - make_type(c.attrib["type"],div3) - span=ET.SubElement(div3,"span") - span.attrib["class"]="identifier member_name" - span.text=" "+c.attrib["name"]+" " - span=ET.SubElement(div3,"span") - span.attrib["class"]="member_description" - span.text=c.text - - - constants = node.find("constants") - if(constants!=None and len(list(constants))>0): - - h4=ET.SubElement(div,"h4") - h4.text="Constants:" - div2=ET.SubElement(div,"div") - div2.attrib["class"]="constant_list"; - - for c in list(constants): - li = ET.SubElement(div2, "li") - div3=ET.SubElement(li,"div") - div3.attrib["class"]="constant"; - - span=ET.SubElement(div3,"span") - span.attrib["class"]="identifier constant_name" - span.text=c.attrib["name"]+" " - if ("value" in c.attrib): - span=ET.SubElement(div3,"span") - span.attrib["class"]="symbol" - span.text="= " - span=ET.SubElement(div3,"span") - span.attrib["class"]="constant_value" - span.text=c.attrib["value"]+" " - span=ET.SubElement(div3,"span") - span.attrib["class"]="constant_description" - span.text=c.text - -# ET.SubElement(div,"br") - - - descr=node.find("description") - if (descr!=None and descr.text.strip()!=""): - - h4=ET.SubElement(div,"h4") - h4.text="Description:" - - make_text_def(node.attrib["name"],div,descr.text) -# div2=ET.SubElement(div,"div") -# div2.attrib["class"]="description"; -# div2.text=descr.text - - - - if(methods!=None or events!=None): - - h4=ET.SubElement(div,"h4") - h4.text="Method Documentation:" - iter_list = [] - if (methods!=None): - iter_list+=list(methods) - if (events!=None): - iter_list+=list(events) - - for m in iter_list: - - descr=m.find("description") - - if (descr==None or descr.text.strip()==""): - continue; - - div2=ET.SubElement(div,"div") - div2.attrib["class"]="method_doc"; - - - div2.append( make_method_def(node.attrib["name"],m,True) ) - #anchor = ET.SubElement(div2, "a") - #anchor.attrib["name"] = - make_text_def(node.attrib["name"],div2,descr.text) - #div3=ET.SubElement(div2,"div") - #div3.attrib["class"]="description"; - #div3.text=descr.text - - - return div -""" -for file in input_list: - tree = ET.parse(file) - doc = tree.getroot() - - if ("version" not in doc.attrib): - print("Version missing from 'doc'") - sys.exit(255) - - version = doc.attrib["version"] - - for c in list(doc): - if (c.attrib["name"] in class_names): - continue - class_names.append(c.attrib["name"]) - classes[c.attrib["name"]] = c - - -class_names.sort() - -make_class_list(class_names, 4) - -for cn in class_names: - c = classes[cn] - make_doku_class(c) diff --git a/doc/tools/makehtml.py b/doc/tools/makehtml.py deleted file mode 100644 index 3ecb8220cb..0000000000 --- a/doc/tools/makehtml.py +++ /dev/null @@ -1,689 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -import sys -import xml.etree.ElementTree as ET -from xml.sax.saxutils import escape, unescape - -html_escape_table = { - '"': """, - "'": "'" -} - -html_unescape_table = {v: k for k, v in html_escape_table.items()} - - -def html_escape(text): - return escape(text, html_escape_table) - - -def html_unescape(text): - return unescape(text, html_unescape_table) - -input_list = [] - -single_page = True - -for arg in sys.argv[1:]: - if arg[:1] == "-": - if arg[1:] == "multipage": - single_page = False - if arg[1:] == "singlepage": - single_page = True - else: - input_list.append(arg) - -if len(input_list) < 1: - print("usage: makehtml.py <classes.xml>") - sys.exit(0) - - -def validate_tag(elem, tag): - if (elem.tag != tag): - print("Tag mismatch, expected '" + tag + "', got " + elem.tag) - sys.exit(255) - - -def make_html_bottom(body): - # make_html_top(body,True) - ET.SubElement(body, "hr") - copyright = ET.SubElement(body, "span") - copyright.text = "Copyright 2008-2010 Codenix SRL" - - -def make_html_top(body, bottom=False): - - if (bottom): - ET.SubElement(body, "hr") - - table = ET.SubElement(body, "table") - table.attrib["class"] = "top_table" - tr = ET.SubElement(table, "tr") - td = ET.SubElement(tr, "td") - td.attrib["class"] = "top_table" - - img = ET.SubElement(td, "image") - img.attrib["src"] = "images/logo.png" - td = ET.SubElement(tr, "td") - td.attrib["class"] = "top_table" - a = ET.SubElement(td, "a") - a.attrib["href"] = "index.html" - a.text = "Index" - td = ET.SubElement(tr, "td") - td.attrib["class"] = "top_table" - a = ET.SubElement(td, "a") - a.attrib["href"] = "alphabetical.html" - a.text = "Classes" - td = ET.SubElement(tr, "td") - td.attrib["class"] = "top_table" - a = ET.SubElement(td, "a") - a.attrib["href"] = "category.html" - a.text = "Categories" - td = ET.SubElement(tr, "td") - a = ET.SubElement(td, "a") - a.attrib["href"] = "inheritance.html" - a.text = "Inheritance" - if (not bottom): - ET.SubElement(body, "hr") - - -def make_html_class_list(class_list, columns): - - div = ET.Element("div") - div.attrib["class"] = "ClassList" - - h1 = ET.SubElement(div, "h2") - h1.text = "Alphabetical Class List" - - table = ET.SubElement(div, "table") - table.attrib["class"] = "class_table" - table.attrib["width"] = "100%" - prev = 0 - - col_max = len(class_list) / columns + 1 - print("col max is ", col_max) - col_count = 0 - row_count = 0 - last_initial = "" - fit_columns = [] - - for n in range(0, columns): - fit_columns += [[]] - - indexers = [] - last_initial = "" - - idx = 0 - for n in class_list: - col = int(idx / col_max) - if (col >= columns): - col = columns - 1 - fit_columns[col] += [n] - idx += 1 - if (n[:1] != last_initial): - indexers += [n] - last_initial = n[:1] - - row_max = 0 - - for n in range(0, columns): - if (len(fit_columns[n]) > row_max): - row_max = len(fit_columns[n]) - - for r in range(0, row_max): - tr = ET.SubElement(table, "tr") - for c in range(0, columns): - tdi = ET.SubElement(tr, "td") - tdi.attrib["align"] = "right" - td = ET.SubElement(tr, "td") - if (r >= len(fit_columns[c])): - continue - - classname = fit_columns[c][r] - print(classname) - if (classname in indexers): - - span = ET.SubElement(tdi, "span") - span.attrib["class"] = "class_index_letter" - span.text = classname[:1].upper() - - if (single_page): - link = "#" + classname - else: - link = classname + ".html" - - a = ET.SubElement(td, "a") - a.attrib["href"] = link - a.text = classname - - if (not single_page): - cat_class_list = ET.Element("html") - csscc = ET.SubElement(cat_class_list, "link") - csscc.attrib["href"] = "main.css" - csscc.attrib["rel"] = "stylesheet" - csscc.attrib["type"] = "text/css" - bodycc = ET.SubElement(cat_class_list, "body") - make_html_top(bodycc) - - cat_class_parent = bodycc - else: - cat_class_parent = div - - h1 = ET.SubElement(cat_class_parent, "h2") - h1.text = "Class List By Category" - - class_cat_table = {} - class_cat_list = [] - - for c in class_list: - clss = classes[c] - if ("category" in clss.attrib): - class_cat = clss.attrib["category"] - else: - class_cat = "Core" - if (class_cat.find("/") != -1): - class_cat = class_cat[class_cat.rfind("/") + 1:] - if (not class_cat in class_cat_list): - class_cat_list.append(class_cat) - class_cat_table[class_cat] = [] - class_cat_table[class_cat].append(c) - - class_cat_list.sort() - - ct = ET.SubElement(cat_class_parent, "table") - for cl in class_cat_list: - l = class_cat_table[cl] - l.sort() - tr = ET.SubElement(ct, "tr") - tr.attrib["class"] = "category_title" - td = ET.SubElement(ct, "td") - td.attrib["class"] = "category_title" - - a = ET.SubElement(td, "a") - a.attrib["class"] = "category_title" - a.text = cl - a.attrib["name"] = "CATEGORY_" + cl - - td = ET.SubElement(ct, "td") - td.attrib["class"] = "category_title" - - for clt in l: - tr = ET.SubElement(ct, "tr") - td = ET.SubElement(ct, "td") - make_type(clt, td) - clss = classes[clt] - bd = clss.find("brief_description") - bdtext = "" - if (bd != None): - bdtext = bd.text - td = ET.SubElement(ct, "td") - td.text = bdtext - - if (not single_page): - make_html_bottom(bodycc) - catet_out = ET.ElementTree(cat_class_list) - catet_out.write("category.html") - - if (not single_page): - inh_class_list = ET.Element("html") - cssic = ET.SubElement(inh_class_list, "link") - cssic.attrib["href"] = "main.css" - cssic.attrib["rel"] = "stylesheet" - cssic.attrib["type"] = "text/css" - bodyic = ET.SubElement(inh_class_list, "body") - make_html_top(bodyic) - inh_class_parent = bodyic - else: - inh_class_parent = div - - h1 = ET.SubElement(inh_class_parent, "h2") - h1.text = "Class List By Inheritance" - - itemlist = ET.SubElement(inh_class_parent, "list") - - class_inh_table = {} - - def add_class(clss): - if (clss.attrib["name"] in class_inh_table): - return # already added - parent_list = None - - if ("inherits" in clss.attrib): - inhc = clss.attrib["inherits"] - if (not (inhc in class_inh_table)): - add_class(classes[inhc]) - - parent_list = class_inh_table[inhc].find("div") - if (parent_list == None): - parent_div = ET.SubElement(class_inh_table[inhc], "div") - parent_list = ET.SubElement(parent_div, "list") - parent_div.attrib["class"] = "inh_class_list" - else: - parent_list = parent_list.find("list") - - else: - parent_list = itemlist - - item = ET.SubElement(parent_list, "li") -# item.attrib["class"]="inh_class_list" - class_inh_table[clss.attrib["name"]] = item - make_type(clss.attrib["name"], item) - - for c in class_list: - add_class(classes[c]) - - if (not single_page): - make_html_bottom(bodyic) - catet_out = ET.ElementTree(inh_class_list) - catet_out.write("inheritance.html") - - # h1=ET.SubElement(div,"h2") - #h1.text="Class List By Inheritance" - - return div - - -def make_type(p_type, p_parent): - if (p_type == "RefPtr"): - p_type = "Resource" - - if (p_type in class_names): - a = ET.SubElement(p_parent, "a") - a.attrib["class"] = "datatype_existing" - a.text = p_type + " " - if (single_page): - a.attrib["href"] = "#" + p_type - else: - a.attrib["href"] = p_type + ".html" - else: - span = ET.SubElement(p_parent, "span") - span.attrib["class"] = "datatype" - span.text = p_type + " " - - -def make_text_def(class_name, parent, text): - text = html_escape(text) - pos = 0 - while(True): - pos = text.find("[", pos) - if (pos == -1): - break - - endq_pos = text.find("]", pos + 1) - if (endq_pos == -1): - break - - pre_text = text[:pos] - post_text = text[endq_pos + 1:] - tag_text = text[pos + 1:endq_pos] - - if (tag_text in class_names): - if (single_page): - tag_text = '<a href="#' + tag_text + '">' + tag_text + '</a>' - else: - tag_text = '<a href="' + tag_text + '.html">' + tag_text + '</a>' - else: # command - cmd = tag_text - space_pos = tag_text.find(" ") - if (cmd.find("html") == 0): - cmd = tag_text[:space_pos] - param = tag_text[space_pos + 1:] - tag_text = "<" + param + ">" - elif(cmd.find("method") == 0): - cmd = tag_text[:space_pos] - param = tag_text[space_pos + 1:] - - if (not single_page and param.find(".") != -1): - class_param, method_param = param.split(".") - tag_text = tag_text = '<a href="' + class_param + '.html#' + class_param + "_" + method_param + '">' + class_param + '.' + method_param + '()</a>' - else: - tag_text = tag_text = '<a href="#' + class_name + "_" + param + '">' + class_name + '.' + param + '()</a>' - elif (cmd.find("image=") == 0): - print("found image: " + cmd) - tag_text = "<img src=" + cmd[6:] + "/>" - elif (cmd.find("url=") == 0): - tag_text = "<a href=" + cmd[4:] + ">" - elif (cmd == "/url"): - tag_text = "</a>" - elif (cmd == "center"): - tag_text = "<div align=\"center\">" - elif (cmd == "/center"): - tag_text = "</div>" - elif (cmd == "br"): - tag_text = "<br/>" - elif (cmd == "i" or cmd == "/i" or cmd == "b" or cmd == "/b" or cmd == "u" or cmd == "/u"): - tag_text = "<" + tag_text + ">" # html direct mapping - else: - tag_text = "[" + tag_text + "]" - - text = pre_text + tag_text + post_text - pos = len(pre_text) + len(tag_text) - - #tnode = ET.SubElement(parent,"div") - # tnode.text=text - text = "<div class=\"description\">" + text + "</div>" - try: - tnode = ET.XML(text) - parent.append(tnode) - except: - print("Error parsing description text: '" + text + "'") - sys.exit(255) - - return tnode - - -def make_method_def(name, m, declare, event=False): - - mdata = {} - - if (not declare): - div = ET.Element("tr") - div.attrib["class"] = "method" - ret_parent = ET.SubElement(div, "td") - ret_parent.attrib["align"] = "right" - func_parent = ET.SubElement(div, "td") - else: - div = ET.Element("div") - div.attrib["class"] = "method" - ret_parent = div - func_parent = div - - mdata["argidx"] = [] - mdata["name"] = m.attrib["name"] - qualifiers = "" - if ("qualifiers" in m.attrib): - qualifiers = m.attrib["qualifiers"] - - args = list(m) - for a in args: - if (a.tag == "return"): - idx = -1 - elif (a.tag == "argument"): - idx = int(a.attrib["index"]) - else: - continue - - mdata["argidx"].append(idx) - mdata[idx] = a - - if (not event): - if (-1 in mdata["argidx"]): - make_type(mdata[-1].attrib["type"], ret_parent) - mdata["argidx"].remove(-1) - else: - make_type("void", ret_parent) - - span = ET.SubElement(func_parent, "span") - if (declare): - span.attrib["class"] = "funcdecl" - a = ET.SubElement(span, "a") - a.attrib["name"] = name + "_" + m.attrib["name"] - a.text = name + "::" + m.attrib["name"] - else: - span.attrib["class"] = "identifier funcdef" - a = ET.SubElement(span, "a") - a.attrib["href"] = "#" + name + "_" + m.attrib["name"] - a.text = m.attrib["name"] - - span = ET.SubElement(func_parent, "span") - span.attrib["class"] = "symbol" - span.text = " (" - - for a in mdata["argidx"]: - arg = mdata[a] - if (a > 0): - span = ET.SubElement(func_parent, "span") - span.text = ", " - else: - span = ET.SubElement(func_parent, "span") - span.text = " " - - make_type(arg.attrib["type"], func_parent) - - span = ET.SubElement(func_parent, "span") - span.text = arg.attrib["name"] - if ("default" in arg.attrib): - span.text = span.text + "=" + arg.attrib["default"] - - span = ET.SubElement(func_parent, "span") - span.attrib["class"] = "symbol" - if (len(mdata["argidx"])): - span.text = " )" - else: - span.text = ")" - - if (qualifiers): - span = ET.SubElement(func_parent, "span") - span.attrib["class"] = "qualifier" - span.text = " " + qualifiers - - return div - - -def make_html_class(node): - - div = ET.Element("div") - div.attrib["class"] = "class" - - a = ET.SubElement(div, "a") - a.attrib["name"] = node.attrib["name"] - - h3 = ET.SubElement(a, "h3") - h3.attrib["class"] = "title class_title" - h3.text = node.attrib["name"] - - briefd = node.find("brief_description") - if (briefd != None): - div2 = ET.SubElement(div, "div") - div2.attrib["class"] = "description class_description" - div2.text = briefd.text - - if ("inherits" in node.attrib): - ET.SubElement(div, "br") - - div2 = ET.SubElement(div, "div") - div2.attrib["class"] = "inheritance" - - span = ET.SubElement(div2, "span") - span.text = "Inherits: " - - make_type(node.attrib["inherits"], div2) - - if ("category" in node.attrib): - ET.SubElement(div, "br") - - div3 = ET.SubElement(div, "div") - div3.attrib["class"] = "category" - - span = ET.SubElement(div3, "span") - span.attrib["class"] = "category" - span.text = "Category: " - - a = ET.SubElement(div3, "a") - a.attrib["class"] = "category_ref" - a.text = node.attrib["category"] - catname = a.text - if (catname.rfind("/") != -1): - catname = catname[catname.rfind("/"):] - catname = "CATEGORY_" + catname - - if (single_page): - a.attrib["href"] = "#" + catname - else: - a.attrib["href"] = "category.html#" + catname - - methods = node.find("methods") - - if(methods != None and len(list(methods)) > 0): - - h4 = ET.SubElement(div, "h4") - h4.text = "Public Methods:" - - method_table = ET.SubElement(div, "table") - method_table.attrib["class"] = "method_list" - - for m in list(methods): - #li = ET.SubElement(div2, "li") - method_table.append(make_method_def(node.attrib["name"], m, False)) - - events = node.find("signals") - - if(events != None and len(list(events)) > 0): - h4 = ET.SubElement(div, "h4") - h4.text = "Events:" - - event_table = ET.SubElement(div, "table") - event_table.attrib["class"] = "method_list" - - for m in list(events): - #li = ET.SubElement(div2, "li") - event_table.append(make_method_def(node.attrib["name"], m, False, True)) - - members = node.find("members") - if(members != None and len(list(members)) > 0): - - h4 = ET.SubElement(div, "h4") - h4.text = "Public Variables:" - div2 = ET.SubElement(div, "div") - div2.attrib["class"] = "member_list" - - for c in list(members): - - li = ET.SubElement(div2, "li") - div3 = ET.SubElement(li, "div") - div3.attrib["class"] = "member" - make_type(c.attrib["type"], div3) - span = ET.SubElement(div3, "span") - span.attrib["class"] = "identifier member_name" - span.text = " " + c.attrib["name"] + " " - span = ET.SubElement(div3, "span") - span.attrib["class"] = "member_description" - span.text = c.text - - constants = node.find("constants") - if(constants != None and len(list(constants)) > 0): - - h4 = ET.SubElement(div, "h4") - h4.text = "Constants:" - div2 = ET.SubElement(div, "div") - div2.attrib["class"] = "constant_list" - - for c in list(constants): - li = ET.SubElement(div2, "li") - div3 = ET.SubElement(li, "div") - div3.attrib["class"] = "constant" - - span = ET.SubElement(div3, "span") - span.attrib["class"] = "identifier constant_name" - span.text = c.attrib["name"] + " " - if ("value" in c.attrib): - span = ET.SubElement(div3, "span") - span.attrib["class"] = "symbol" - span.text = "= " - span = ET.SubElement(div3, "span") - span.attrib["class"] = "constant_value" - span.text = c.attrib["value"] + " " - span = ET.SubElement(div3, "span") - span.attrib["class"] = "constant_description" - span.text = c.text - -# ET.SubElement(div,"br") - - descr = node.find("description") - if (descr != None and descr.text.strip() != ""): - h4 = ET.SubElement(div, "h4") - h4.text = "Description:" - - make_text_def(node.attrib["name"], div, descr.text) -# div2=ET.SubElement(div,"div") -# div2.attrib["class"]="description"; -# div2.text=descr.text - - if(methods != None or events != None): - - h4 = ET.SubElement(div, "h4") - h4.text = "Method Documentation:" - iter_list = [] - if (methods != None): - iter_list += list(methods) - if (events != None): - iter_list += list(events) - - for m in iter_list: - - descr = m.find("description") - - if (descr == None or descr.text.strip() == ""): - continue - - div2 = ET.SubElement(div, "div") - div2.attrib["class"] = "method_doc" - - div2.append(make_method_def(node.attrib["name"], m, True)) - #anchor = ET.SubElement(div2, "a") - # anchor.attrib["name"] = - make_text_def(node.attrib["name"], div2, descr.text) - # div3=ET.SubElement(div2,"div") - # div3.attrib["class"]="description"; - # div3.text=descr.text - - return div - -class_names = [] -classes = {} - -for file in input_list: - tree = ET.parse(file) - doc = tree.getroot() - - if ("version" not in doc.attrib): - print("Version missing from 'doc'") - sys.exit(255) - - version = doc.attrib["version"] - - for c in list(doc): - if (c.attrib["name"] in class_names): - continue - class_names.append(c.attrib["name"]) - classes[c.attrib["name"]] = c - -html = ET.Element("html") -css = ET.SubElement(html, "link") -css.attrib["href"] = "main.css" -css.attrib["rel"] = "stylesheet" -css.attrib["type"] = "text/css" - -body = ET.SubElement(html, "body") -if (not single_page): - make_html_top(body) - - -class_names.sort() - -body.append(make_html_class_list(class_names, 5)) - -for cn in class_names: - c = classes[cn] - if (single_page): - body.append(make_html_class(c)) - else: - html2 = ET.Element("html") - css = ET.SubElement(html2, "link") - css.attrib["href"] = "main.css" - css.attrib["rel"] = "stylesheet" - css.attrib["type"] = "text/css" - body2 = ET.SubElement(html2, "body") - make_html_top(body2) - body2.append(make_html_class(c)) - make_html_bottom(body2) - et_out = ET.ElementTree(html2) - et_out.write(c.attrib["name"] + ".html") - - -et_out = ET.ElementTree(html) -if (single_page): - et_out.write("singlepage.html") -else: - make_html_bottom(body) - et_out.write("alphabetical.html") diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py index bd0d4c6819..b2444eb47b 100644 --- a/doc/tools/makemd.py +++ b/doc/tools/makemd.py @@ -273,6 +273,12 @@ def make_doku_class(node): f.write('\n### Signals \n') for m in list(events): make_method(f, node.attrib['name'], m, True, True) + d = m.find('description') + if d == None or d.text.strip() == '': + continue + f.write('\n') + f.write(dokuize_text(d.text.strip())) + f.write('\n') members = node.find('members') diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 6b6780ce1e..8a117f6450 100644 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -441,6 +441,12 @@ def make_rst_class(node): f.write(make_heading('Signals', '-')) for m in list(events): make_method(f, node.attrib['name'], m, True, name, True) + d = m.find('description') + if d == None or d.text.strip() == '': + continue + f.write(rstize_text(d.text.strip(), name)) + f.write("\n\n") + f.write('\n') members = node.find('members') |