diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2018-05-28 14:53:15 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2018-05-28 14:53:15 +0200 |
commit | 4c5dd51eb9253478bfb5b106ea22a24f5b55133c (patch) | |
tree | bbed8ea64655fffb8c56953bca573faabc4e23ed /doc/classes | |
parent | ddc24347ba0170d73d804a320a16739be17328c8 (diff) |
Sync classref with current source
Also fix binding of Basis.slerp
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/AnimationTreePlayer.xml | 8 | ||||
-rw-r--r-- | doc/classes/ColorPickerButton.xml | 2 | ||||
-rw-r--r-- | doc/classes/EditorInspector.xml | 37 | ||||
-rw-r--r-- | doc/classes/EditorInspectorPlugin.xml | 95 | ||||
-rw-r--r-- | doc/classes/EditorPlugin.xml | 26 | ||||
-rw-r--r-- | doc/classes/EditorProperty.xml | 111 | ||||
-rw-r--r-- | doc/classes/EditorSettings.xml | 4 | ||||
-rw-r--r-- | doc/classes/OrientedPathFollow.xml | 2 | ||||
-rw-r--r-- | doc/classes/PhysicalBone.xml | 16 | ||||
-rw-r--r-- | doc/classes/Physics2DServer.xml | 22 | ||||
-rw-r--r-- | doc/classes/PhysicsServer.xml | 22 | ||||
-rw-r--r-- | doc/classes/ProceduralSky.xml | 2 | ||||
-rw-r--r-- | doc/classes/Quat.xml | 34 | ||||
-rw-r--r-- | doc/classes/Range.xml | 4 | ||||
-rw-r--r-- | doc/classes/ScrollContainer.xml | 4 | ||||
-rw-r--r-- | doc/classes/ShaderMaterial.xml | 8 | ||||
-rw-r--r-- | doc/classes/Skeleton.xml | 10 | ||||
-rw-r--r-- | doc/classes/String.xml | 28 | ||||
-rw-r--r-- | doc/classes/TextEdit.xml | 2 | ||||
-rw-r--r-- | doc/classes/TileMap.xml | 14 | ||||
-rw-r--r-- | doc/classes/TileSet.xml | 4 | ||||
-rw-r--r-- | doc/classes/Vector2.xml | 4 | ||||
-rw-r--r-- | doc/classes/Vector3.xml | 2 |
23 files changed, 402 insertions, 59 deletions
diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 49b4c6b43e..8c32d5f6a3 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -50,6 +50,14 @@ Returns the name of the [member master_player]'s [Animation] bound to this animation node. </description> </method> + <method name="animation_node_get_position" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> <method name="animation_node_set_animation"> <return type="void"> </return> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 656fce587f..9d7df14014 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -11,7 +11,7 @@ <demos> </demos> <methods> - <method name="get_picker" qualifiers="const"> + <method name="get_picker"> <return type="ColorPicker"> </return> <description> diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml new file mode 100644 index 0000000000..381eef5a40 --- /dev/null +++ b/doc/classes/EditorInspector.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorInspector" inherits="ScrollContainer" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <signals> + <signal name="object_id_selected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="resource_selected"> + <argument index="0" name="res" type="Object"> + </argument> + <argument index="1" name="prop" type="String"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml new file mode 100644 index 0000000000..c614575e8e --- /dev/null +++ b/doc/classes/EditorInspectorPlugin.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorInspectorPlugin" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_custom_control"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + </description> + </method> + <method name="add_property_editor"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="editor" type="Control"> + </argument> + <description> + </description> + </method> + <method name="add_property_editor_for_multiple_properties"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="properties" type="PoolStringArray"> + </argument> + <argument index="2" name="editor" type="Control"> + </argument> + <description> + </description> + </method> + <method name="can_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + </description> + </method> + <method name="parse_begin" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + </description> + </method> + <method name="parse_category" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="category" type="String"> + </argument> + <description> + </description> + </method> + <method name="parse_end" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="parse_property" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="path" type="String"> + </argument> + <argument index="3" name="hint" type="int"> + </argument> + <argument index="4" name="hint_text" type="String"> + </argument> + <argument index="5" name="usage" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index e8e2c4fd74..860d98ab62 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -81,7 +81,7 @@ <method name="add_export_plugin"> <return type="void"> </return> - <argument index="0" name="exporter" type="EditorExportPlugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> </description> @@ -94,6 +94,14 @@ <description> </description> </method> + <method name="add_inspector_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorInspectorPlugin"> + </argument> + <description> + </description> + </method> <method name="add_scene_import_plugin"> <return type="void"> </return> @@ -135,6 +143,12 @@ This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. </description> </method> + <method name="build" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="clear" qualifiers="virtual"> <return type="void"> </return> @@ -341,7 +355,7 @@ <method name="remove_export_plugin"> <return type="void"> </return> - <argument index="0" name="exporter" type="EditorExportPlugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> </description> @@ -354,6 +368,14 @@ <description> </description> </method> + <method name="remove_inspector_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorInspectorPlugin"> + </argument> + <description> + </description> + </method> <method name="remove_scene_import_plugin"> <return type="void"> </return> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml new file mode 100644 index 0000000000..9b5452ec14 --- /dev/null +++ b/doc/classes/EditorProperty.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorProperty" inherits="Container" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_edited_object"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_edited_property"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="update_property" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="checkable" type="bool" setter="set_checkable" getter="is_checkable"> + </member> + <member name="checked" type="bool" setter="set_checked" getter="is_checked"> + </member> + <member name="draw_red" type="bool" setter="set_draw_red" getter="is_draw_red"> + </member> + <member name="keying" type="bool" setter="set_keying" getter="is_keying"> + </member> + <member name="label" type="String" setter="set_label" getter="get_label"> + </member> + <member name="read_only" type="bool" setter="set_read_only" getter="is_read_only"> + </member> + </members> + <signals> + <signal name="multiple_properties_changed"> + <argument index="0" name="properties" type="PoolStringArray"> + </argument> + <argument index="1" name="value" type="Array"> + </argument> + <description> + </description> + </signal> + <signal name="object_id_selected"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="property_changed"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Nil"> + </argument> + <description> + </description> + </signal> + <signal name="property_checked"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="bool" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed_with_value"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Nil"> + </argument> + <description> + </description> + </signal> + <signal name="resource_selected"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="resource" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="selected"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="focusable_idx" type="int"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 5325a67de3..bd85075b7e 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -67,7 +67,7 @@ <description> </description> </method> - <method name="get_project_settings_dir"> + <method name="get_project_settings_dir" qualifiers="const"> <return type="String"> </return> <description> @@ -144,6 +144,8 @@ </description> </method> <method name="set_project_metadata"> + <return type="void"> + </return> <argument index="0" name="section" type="String"> </argument> <argument index="1" name="key" type="String"> diff --git a/doc/classes/OrientedPathFollow.xml b/doc/classes/OrientedPathFollow.xml index c32e545ff5..85d60936ad 100644 --- a/doc/classes/OrientedPathFollow.xml +++ b/doc/classes/OrientedPathFollow.xml @@ -5,7 +5,7 @@ </brief_description> <description> This node behaves like [PathFollow], except it uses its parent [Path] up vector information to enforce orientation. - Make sure to check if the curve of this node's parent [Path] has up vectors enabled. See [PathFollow] and [Curve3D] for further information. + Make sure to check if the curve of this node's parent [Path] has up vectors enabled. See [PathFollow] and [Curve3D] for further information. </description> <tutorials> </tutorials> diff --git a/doc/classes/PhysicalBone.xml b/doc/classes/PhysicalBone.xml index 80b3c11270..99f551b865 100644 --- a/doc/classes/PhysicalBone.xml +++ b/doc/classes/PhysicalBone.xml @@ -9,12 +9,24 @@ <demos> </demos> <methods> + <method name="get_simulate_physics"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_simulating_physics"> <return type="bool"> </return> <description> </description> </method> + <method name="is_static_body"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <members> <member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset"> @@ -31,10 +43,6 @@ </member> <member name="mass" type="float" setter="set_mass" getter="get_mass"> </member> - <member name="simulate_physics" type="bool" setter="set_simulate_physics" getter="get_simulate_physics"> - </member> - <member name="static_body" type="bool" setter="set_static_body" getter="is_static_body"> - </member> <member name="weight" type="float" setter="set_weight" getter="get_weight"> </member> </members> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 4a678d9f6b..c302797704 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -140,6 +140,18 @@ Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> + <method name="area_set_area_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> <method name="area_set_collision_layer"> <return type="void"> </return> @@ -180,6 +192,16 @@ 5: The shape index of the area where the object entered/exited. </description> </method> + <method name="area_set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="monitorable" type="bool"> + </argument> + <description> + </description> + </method> <method name="area_set_param"> <return type="void"> </return> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index f5311974f2..6efbfdb519 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -149,6 +149,18 @@ Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> + <method name="area_set_area_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> <method name="area_set_collision_layer"> <return type="void"> </return> @@ -189,6 +201,16 @@ 5: The shape index of the area where the object entered/exited. </description> </method> + <method name="area_set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="monitorable" type="bool"> + </argument> + <description> + </description> + </method> <method name="area_set_param"> <return type="void"> </return> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 664c80be5e..df0519b2ad 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -54,7 +54,7 @@ Amount of energy contribution from the sun. </member> <member name="sun_latitude" type="float" setter="set_sun_latitude" getter="get_sun_latitude"> - The suns height using polar coordinates. + The suns height using polar coordinates. </member> <member name="sun_longitude" type="float" setter="set_sun_longitude" getter="get_sun_longitude"> The direction of the sun using polar coordinates. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 4121790881..589f7d00c6 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -19,45 +19,45 @@ <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <argument index="2" name="z" type="float"> - </argument> - <argument index="3" name="w" type="float"> + <argument index="0" name="from" type="Basis"> </argument> <description> - Returns a quaternion defined by these values. + Returns the rotation matrix corresponding to the given quaternion. </description> </method> <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="angle" type="float"> + <argument index="0" name="euler" type="Vector3"> </argument> <description> - Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. + Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). </description> </method> <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="euler" type="Vector3"> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="angle" type="float"> </argument> <description> - Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). + Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> </method> <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="from" type="Basis"> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <argument index="3" name="w" type="float"> </argument> <description> - Returns the rotation matrix corresponding to the given quaternion. + Returns a quaternion defined by these values. </description> </method> <method name="cubic_slerp"> @@ -129,7 +129,7 @@ <method name="set_axis_angle"> <argument index="0" name="axis" type="Vector3"> </argument> - <argument index="1" name="phi" type="float"> + <argument index="1" name="angle" type="float"> </argument> <description> Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 545f5cc83b..fa7e20eff6 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -29,6 +29,10 @@ </method> </methods> <members> + <member name="allow_greater" type="bool" setter="set_allow_greater" getter="is_greater_allowed"> + </member> + <member name="allow_lesser" type="bool" setter="set_allow_lesser" getter="is_lesser_allowed"> + </member> <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp"> If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. </member> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index f16b3920c2..3a99a203ae 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -42,4 +42,8 @@ </signals> <constants> </constants> + <theme_items> + <theme_item name="bg" type="StyleBox"> + </theme_item> + </theme_items> </class> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 058e00e46c..5abba9fba9 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ShaderMaterial" inherits="Material" category="Core" version="3.1"> <brief_description> - A material that uses a custom [Shader] program + A material that uses a custom [Shader] program. </brief_description> <description> A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. @@ -17,7 +17,7 @@ <argument index="0" name="param" type="String"> </argument> <description> - Returns the current value set for this material of a uniform in the shader + Returns the current value set for this material of a uniform in the shader. </description> </method> <method name="set_shader_param"> @@ -28,13 +28,13 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Changes the value set for this material of a uniform in the shader + Changes the value set for this material of a uniform in the shader. </description> </method> </methods> <members> <member name="shader" type="Shader" setter="set_shader" getter="get_shader"> - The [Shader] program used to render this material + The [Shader] program used to render this material. </member> </members> <constants> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 67e10e8f0a..0f96ee01ff 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -147,14 +147,20 @@ <description> </description> </method> - <method name="physical_bones_simulation"> + <method name="physical_bones_start_simulation"> <return type="void"> </return> - <argument index="0" name="start" type="bool"> + <argument index="0" name="bones" type="Array" default="[ ]"> </argument> <description> </description> </method> + <method name="physical_bones_stop_simulation"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="set_bone_custom_pose"> <return type="void"> </return> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index a55e184474..0ba1066dfd 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -643,6 +643,20 @@ Returns the right side of the string from a given position. </description> </method> + <method name="rsplit"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="divisor" type="String"> + </argument> + <argument index="1" name="allow_empty" type="bool" default="True"> + </argument> + <argument index="2" name="maxsplit" type="int" default="0"> + </argument> + <description> + Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items. + </description> + </method> <method name="rstrip"> <return type="String"> </return> @@ -688,20 +702,6 @@ If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) </description> </method> - <method name="rsplit"> - <return type="PoolStringArray"> - </return> - <argument index="0" name="divisor" type="String"> - </argument> - <argument index="1" name="allow_empty" type="bool" default="True"> - </argument> - <argument index="2" name="maxsplit" type="int" default="0"> - </argument> - <description> - Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". - If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items. - </description> - </method> <method name="split_floats"> <return type="PoolRealArray"> </return> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 11fc00d129..ee9b7383e5 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -386,7 +386,7 @@ <member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed"> If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible. </member> - <member name="wrap_lines" type="bool" setter="set_wrap" getter="is_wrapping"> + <member name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled"> </member> </members> <signals> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 775fef4fb7..5af29d96cd 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -52,7 +52,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns [code]true[/code] if the given collision layer bit is set. + Returns [code]true[/code] if the given collision layer bit is set. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -61,7 +61,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns [code]true[/code] if the given collision mask bit is set. + Returns [code]true[/code] if the given collision mask bit is set. </description> </method> <method name="get_used_cells" qualifiers="const"> @@ -77,14 +77,14 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns an array of all cells with the given tile id. + Returns an array of all cells with the given tile id. </description> </method> <method name="get_used_rect"> <return type="Rect2"> </return> <description> - Returns a rectangle enclosing the used (non-empty) tiles of the map. + Returns a rectangle enclosing the used (non-empty) tiles of the map. </description> </method> <method name="is_cell_transposed" qualifiers="const"> @@ -128,7 +128,7 @@ <argument index="1" name="ignore_half_ofs" type="bool" default="false"> </argument> <description> - Returns the global position corresponding to the given tilemap (grid-based) coordinates. + Returns the global position corresponding to the given tilemap (grid-based) coordinates. Optionally, the tilemap's half offset can be ignored. </description> </method> @@ -193,7 +193,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets the given collision mask bit. + Sets the given collision mask bit. </description> </method> <method name="update_bitmask_area"> @@ -223,7 +223,7 @@ <argument index="0" name="world_position" type="Vector2"> </argument> <description> - Returns the tilemap (grid-based) coordinatescorresponding to the given global position. + Returns the tilemap (grid-based) coordinatescorresponding to the given global position. </description> </method> </methods> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 8f7969505e..bdf8634a6c 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -450,7 +450,9 @@ <constants> <constant name="BITMASK_2X2" value="0" enum="BitmaskMode"> </constant> - <constant name="BITMASK_3X3" value="1" enum="BitmaskMode"> + <constant name="BITMASK_3X3_MINIMAL" value="1" enum="BitmaskMode"> + </constant> + <constant name="BITMASK_3X3" value="2" enum="BitmaskMode"> </constant> <constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings"> </constant> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index e3fbaff62d..923be94db9 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -34,7 +34,7 @@ <return type="float"> </return> <description> - Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector. + Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector. Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code]. </description> </method> @@ -190,7 +190,7 @@ <argument index="0" name="n" type="Vector2"> </argument> <description> - Returns the vector reflected from a plane defined by the given normal. + Returns the vector reflected from a plane defined by the given normal. </description> </method> <method name="rotated"> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 84c16c9fc5..edd0965b64 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -151,7 +151,7 @@ <argument index="1" name="t" type="float"> </argument> <description> - Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. + Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. </description> </method> <method name="max_axis"> |