summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Array.xml16
-rw-r--r--doc/classes/CPUParticles2D.xml193
-rw-r--r--doc/classes/ClippedCamera.xml87
-rw-r--r--doc/classes/EditorPlugin.xml16
-rw-r--r--doc/classes/OS.xml12
-rw-r--r--doc/classes/Physics2DDirectSpaceState.xml18
-rw-r--r--doc/classes/Physics2DShapeQueryParameters.xml4
-rw-r--r--doc/classes/PhysicsDirectBodyState.xml8
-rw-r--r--doc/classes/PhysicsDirectSpaceState.xml14
-rw-r--r--doc/classes/PhysicsShapeQueryParameters.xml4
-rw-r--r--doc/classes/Plane.xml6
-rw-r--r--doc/classes/ProjectSettings.xml6
-rw-r--r--doc/classes/RayCast.xml4
-rw-r--r--doc/classes/RayCast2D.xml4
-rw-r--r--doc/classes/RigidBody.xml6
-rw-r--r--doc/classes/Shape.xml4
-rw-r--r--doc/classes/SpatialMaterial.xml12
-rw-r--r--doc/classes/Sprite.xml8
-rw-r--r--doc/classes/TileMap.xml10
-rw-r--r--doc/classes/TileSet.xml22
-rw-r--r--[-rwxr-xr-x]doc/classes/UndoRedo.xml0
-rw-r--r--doc/classes/Viewport.xml6
22 files changed, 426 insertions, 34 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index 9c5ae8ebd0..162e2d3e05 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -216,7 +216,7 @@
<argument index="1" name="value" type="var">
</argument>
<description>
- Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
+ Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]).
</description>
</method>
<method name="invert">
@@ -224,6 +224,20 @@
Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.
</description>
</method>
+ <method name="max">
+ <return type="var">
+ </return>
+ <description>
+ Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.
+ </description>
+ </method>
+ <method name="min">
+ <return type="var">
+ </return>
+ <description>
+ Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.
+ </description>
+ </method>
<method name="pop_back">
<return type="var">
</return>
diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml
new file mode 100644
index 0000000000..6d115e2650
--- /dev/null
+++ b/doc/classes/CPUParticles2D.xml
@@ -0,0 +1,193 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="CPUParticles2D" inherits="Node2D" category="Core" version="3.1">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="convert_from_particles">
+ <return type="void">
+ </return>
+ <argument index="0" name="particles" type="Node">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="restart">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="amount" type="int" setter="set_amount" getter="get_amount">
+ </member>
+ <member name="angle" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="angle_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="angle_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="angular_velocity" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="anim_loop" type="bool" setter="set_particle_flag" getter="get_particle_flag">
+ </member>
+ <member name="anim_offset" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="anim_offset_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="anim_speed" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="anim_speed_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="anim_speed_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="color" type="Color" setter="set_color" getter="get_color">
+ </member>
+ <member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
+ </member>
+ <member name="damping" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="damping_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder">
+ </member>
+ <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
+ </member>
+ <member name="emission_normals" type="PoolVector2Array" setter="set_emission_normals" getter="get_emission_normals">
+ </member>
+ <member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points">
+ </member>
+ <member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">
+ </member>
+ <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape">
+ </member>
+ <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
+ </member>
+ <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
+ </member>
+ <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio">
+ </member>
+ <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
+ </member>
+ <member name="flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag">
+ </member>
+ <member name="flatness" type="float" setter="set_flatness" getter="get_flatness">
+ </member>
+ <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
+ </member>
+ <member name="gravity" type="Vector2" setter="set_gravity" getter="get_gravity">
+ </member>
+ <member name="hue_variation" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="hue_variation_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="hue_variation_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="initial_velocity" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="initial_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
+ </member>
+ <member name="linear_accel" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="linear_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates">
+ </member>
+ <member name="normalmap" type="Texture" setter="set_normalmap" getter="get_normalmap">
+ </member>
+ <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
+ </member>
+ <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time">
+ </member>
+ <member name="radial_accel" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="radial_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="radial_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio">
+ </member>
+ <member name="scale" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="scale_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="scale_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">
+ </member>
+ <member name="spread" type="float" setter="set_spread" getter="get_spread">
+ </member>
+ <member name="tangential_accel" type="float" setter="set_param" getter="get_param">
+ </member>
+ <member name="tangential_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
+ </member>
+ <member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
+ </member>
+ <member name="texture" type="Texture" setter="set_texture" getter="get_texture">
+ </member>
+ </members>
+ <constants>
+ <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
+ </constant>
+ <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
+ </constant>
+ <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
+ </constant>
+ <constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
+ </constant>
+ <constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
+ </constant>
+ <constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
+ </constant>
+ <constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
+ </constant>
+ <constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
+ </constant>
+ <constant name="PARAM_DAMPING" value="6" enum="Parameter">
+ </constant>
+ <constant name="PARAM_ANGLE" value="7" enum="Parameter">
+ </constant>
+ <constant name="PARAM_SCALE" value="8" enum="Parameter">
+ </constant>
+ <constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
+ </constant>
+ <constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
+ </constant>
+ <constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
+ </constant>
+ <constant name="PARAM_MAX" value="12" enum="Parameter">
+ </constant>
+ <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
+ </constant>
+ <constant name="FLAG_MAX" value="2" enum="Flags">
+ </constant>
+ <constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
+ </constant>
+ <constant name="EMISSION_SHAPE_CIRCLE" value="1" enum="EmissionShape">
+ </constant>
+ <constant name="EMISSION_SHAPE_RECTANGLE" value="2" enum="EmissionShape">
+ </constant>
+ <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
+ </constant>
+ <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
+ </constant>
+ </constants>
+</class>
diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml
new file mode 100644
index 0000000000..509ddb01fc
--- /dev/null
+++ b/doc/classes/ClippedCamera.xml
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ClippedCamera" inherits="Camera" category="Core" version="3.1">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="add_exception">
+ <return type="void">
+ </return>
+ <argument index="0" name="node" type="Object">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="add_exception_rid">
+ <return type="void">
+ </return>
+ <argument index="0" name="rid" type="RID">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="clear_exceptions">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_collision_mask_bit" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="bit" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="remove_exception">
+ <return type="void">
+ </return>
+ <argument index="0" name="node" type="Object">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="remove_exception_rid">
+ <return type="void">
+ </return>
+ <argument index="0" name="rid" type="RID">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_collision_mask_bit">
+ <return type="void">
+ </return>
+ <argument index="0" name="bit" type="int">
+ </argument>
+ <argument index="1" name="value" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="clip_to_areas" type="bool" setter="set_clip_to_areas" getter="is_clip_to_areas_enabled">
+ </member>
+ <member name="clip_to_bodies" type="bool" setter="set_clip_to_bodies" getter="is_clip_to_bodies_enabled">
+ </member>
+ <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
+ </member>
+ <member name="margin" type="float" setter="set_margin" getter="get_margin">
+ </member>
+ <member name="process_mode" type="int" setter="set_process_mode" getter="get_process_mode" enum="ClippedCamera.ProcessMode">
+ </member>
+ </members>
+ <constants>
+ <constant name="CLIP_PROCESS_PHYSICS" value="0" enum="ProcessMode">
+ </constant>
+ <constant name="CLIP_PROCESS_IDLE" value="1" enum="ProcessMode">
+ </constant>
+ </constants>
+</class>
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index 62fc56e990..5d2407adce 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -470,17 +470,21 @@
</constant>
<constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2" enum="CustomControlContainer">
+ <constant name="CONTAINER_SPATIAL_EDITOR_SIDE_LEFT" value="2" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3" enum="CustomControlContainer">
+ <constant name="CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT" value="3" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4" enum="CustomControlContainer">
+ <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="4" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5" enum="CustomControlContainer">
+ <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="5" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6" enum="CustomControlContainer">
+ <constant name="CONTAINER_CANVAS_EDITOR_SIDE_LEFT" value="6" enum="CustomControlContainer">
</constant>
- <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7" enum="CustomControlContainer">
+ <constant name="CONTAINER_CANVAS_EDITOR_SIDE_RIGHT" value="7" enum="CustomControlContainer">
+ </constant>
+ <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="8" enum="CustomControlContainer">
+ </constant>
+ <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="9" enum="CustomControlContainer">
</constant>
<constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot">
</constant>
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index cf86176086..c41084f853 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -43,6 +43,12 @@
Centers the window on the screen if in windowed mode.
</description>
</method>
+ <method name="close_midi_inputs">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="delay_msec" qualifiers="const">
<return type="void">
</return>
@@ -593,6 +599,12 @@
Resumes native video playback.
</description>
</method>
+ <method name="open_midi_inputs">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="print_all_resources">
<return type="void">
</return>
diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml
index f0fee77a5a..483c71b2c0 100644
--- a/doc/classes/Physics2DDirectSpaceState.xml
+++ b/doc/classes/Physics2DDirectSpaceState.xml
@@ -19,7 +19,7 @@
</argument>
<description>
Checks how far the shape can travel toward a point. Note that both the shape and the motion are supplied through a [Physics2DShapeQueryParameters] object. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [1, 1].
- If the shape can not move, the array will be empty ([code]dir.empty()==true[/code]).
+ If the shape can not move, the array will be empty.
</description>
</method>
<method name="collide_shape">
@@ -47,7 +47,7 @@
[code]point[/code]: The intersection point.
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- If the shape did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead.
+ If the shape did not intersect anything, then an empty dictionary is returned instead.
</description>
</method>
<method name="intersect_point">
@@ -61,6 +61,10 @@
</argument>
<argument index="3" name="collision_layer" type="int" default="2147483647">
</argument>
+ <argument index="4" name="collide_with_bodies" type="bool" default="true">
+ </argument>
+ <argument index="5" name="collide_with_areas" type="bool" default="false">
+ </argument>
<description>
Checks whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
[code]collider[/code]: The colliding object.
@@ -68,7 +72,7 @@
[code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in.
+ Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively.
</description>
</method>
<method name="intersect_ray">
@@ -82,6 +86,10 @@
</argument>
<argument index="3" name="collision_layer" type="int" default="2147483647">
</argument>
+ <argument index="4" name="collide_with_bodies" type="bool" default="true">
+ </argument>
+ <argument index="5" name="collide_with_areas" type="bool" default="false">
+ </argument>
<description>
Intersects a ray in a given space. The returned object is a dictionary with the following fields:
[code]collider[/code]: The colliding object.
@@ -91,8 +99,8 @@
[code]position[/code]: The intersection point.
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- If the ray did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead.
- Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in.
+ If the ray did not intersect anything, then an empty dictionary is returned instead.
+ Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively.
</description>
</method>
<method name="intersect_shape">
diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml
index 391ad6276f..f9e0c5e3de 100644
--- a/doc/classes/Physics2DShapeQueryParameters.xml
+++ b/doc/classes/Physics2DShapeQueryParameters.xml
@@ -22,6 +22,10 @@
</method>
</methods>
<members>
+ <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled">
+ </member>
+ <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
+ </member>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
The physics layer the query should be made on.
</member>
diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml
index 91fc4df4ff..2f3501ae5d 100644
--- a/doc/classes/PhysicsDirectBodyState.xml
+++ b/doc/classes/PhysicsDirectBodyState.xml
@@ -15,6 +15,8 @@
<argument index="0" name="force" type="Vector3">
</argument>
<description>
+ Adds a constant directional force without affecting rotation.
+ This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code].
</description>
</method>
<method name="add_force">
@@ -25,6 +27,7 @@
<argument index="1" name="position" type="Vector3">
</argument>
<description>
+ Adds a constant force (i.e. acceleration).
</description>
</method>
<method name="add_torque">
@@ -33,6 +36,7 @@
<argument index="0" name="torque" type="Vector3">
</argument>
<description>
+ Adds a constant rotational force (i.e. a motor) without affecting position.
</description>
</method>
<method name="apply_central_impulse">
@@ -41,6 +45,8 @@
<argument index="0" name="j" type="Vector3">
</argument>
<description>
+ Applies a single directional impulse without affecting rotation.
+ This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``.
</description>
</method>
<method name="apply_impulse">
@@ -51,6 +57,7 @@
<argument index="1" name="j" type="Vector3">
</argument>
<description>
+ Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin.
</description>
</method>
<method name="apply_torque_impulse">
@@ -59,6 +66,7 @@
<argument index="0" name="j" type="Vector3">
</argument>
<description>
+ Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector.
</description>
</method>
<method name="get_contact_collider" qualifiers="const">
diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml
index 3f0e1a4f70..2f7cf5a8f3 100644
--- a/doc/classes/PhysicsDirectSpaceState.xml
+++ b/doc/classes/PhysicsDirectSpaceState.xml
@@ -21,7 +21,7 @@
</argument>
<description>
Checks whether the shape can travel to a point. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [1, 1].
- If the shape can not move, the array will be empty ([code]dir.empty()==true[/code]).
+ If the shape can not move, the array will be empty.
</description>
</method>
<method name="collide_shape">
@@ -48,7 +48,7 @@
[code]point[/code]: The intersection point.
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- If the shape did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead.
+ If the shape did not intersect anything, then an empty dictionary is returned instead.
</description>
</method>
<method name="intersect_ray">
@@ -60,7 +60,11 @@
</argument>
<argument index="2" name="exclude" type="Array" default="[ ]">
</argument>
- <argument index="3" name="collision_layer" type="int" default="2147483647">
+ <argument index="3" name="collision_mask" type="int" default="2147483647">
+ </argument>
+ <argument index="4" name="collide_with_bodies" type="bool" default="true">
+ </argument>
+ <argument index="5" name="collide_with_areas" type="bool" default="false">
</argument>
<description>
Intersects a ray in a given space. The returned object is a dictionary with the following fields:
@@ -70,8 +74,8 @@
[code]position[/code]: The intersection point.
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- If the ray did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead.
- Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in.
+ If the ray did not intersect anything, then an empty dictionary is returned instead.
+ Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively.
</description>
</method>
<method name="intersect_shape">
diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml
index 2f36e81e27..7cca231ad2 100644
--- a/doc/classes/PhysicsShapeQueryParameters.xml
+++ b/doc/classes/PhysicsShapeQueryParameters.xml
@@ -19,6 +19,10 @@
</method>
</methods>
<members>
+ <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled">
+ </member>
+ <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
+ </member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude">
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml
index 62e4fc5d9d..3d5eada066 100644
--- a/doc/classes/Plane.xml
+++ b/doc/classes/Plane.xml
@@ -157,11 +157,11 @@
</member>
</members>
<constants>
- <constant name="X" value="Plane( 1, 0, 0, 0 )">
+ <constant name="PLANE_YZ" value="Plane( 1, 0, 0, 0 )">
</constant>
- <constant name="Y" value="Plane( 0, 1, 0, 0 )">
+ <constant name="PLANE_XZ" value="Plane( 0, 1, 0, 0 )">
</constant>
- <constant name="Z" value="Plane( 0, 0, 1, 0 )">
+ <constant name="PLANE_XY" value="Plane( 0, 0, 1, 0 )">
</constant>
</constants>
</class>
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 5f828550b9..0bda5909ed 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -656,11 +656,11 @@
</member>
<member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter="">
</member>
- <member name="rendering/quality/driver/driver_name" type="String" setter="" getter="">
- </member>
<member name="rendering/quality/driver/driver_fallback" type="String" setter="" getter="">
Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function.
</member>
+ <member name="rendering/quality/driver/driver_name" type="String" setter="" getter="">
+ </member>
<member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter="">
Maximum Anisotropic filter level used for textures when anisotropy enabled.
</member>
@@ -726,6 +726,8 @@
<member name="rendering/threads/thread_model" type="int" setter="" getter="">
Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter.
</member>
+ <member name="rendering/vram_compression/import_bptc" type="bool" setter="" getter="">
+ </member>
<member name="rendering/vram_compression/import_etc" type="bool" setter="" getter="">
If the project uses this compression (usually low end mobile), texture importer will import these.
</member>
diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml
index dce73d9c29..910f5c8ad4 100644
--- a/doc/classes/RayCast.xml
+++ b/doc/classes/RayCast.xml
@@ -135,6 +135,10 @@
<member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
+ <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled">
+ </member>
+ <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
+ </member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
</member>
diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml
index 79e733bcdc..8ba9ee2bcf 100644
--- a/doc/classes/RayCast2D.xml
+++ b/doc/classes/RayCast2D.xml
@@ -134,6 +134,10 @@
<member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
+ <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled">
+ </member>
+ <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
+ </member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
</member>
diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml
index 038464e127..4ae1ef8e94 100644
--- a/doc/classes/RigidBody.xml
+++ b/doc/classes/RigidBody.xml
@@ -30,6 +30,8 @@
<argument index="0" name="force" type="Vector3">
</argument>
<description>
+ Adds a constant directional force without affecting rotation.
+ This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code].
</description>
</method>
<method name="add_force">
@@ -40,6 +42,7 @@
<argument index="1" name="position" type="Vector3">
</argument>
<description>
+ Adds a constant force (i.e. acceleration).
</description>
</method>
<method name="add_torque">
@@ -48,6 +51,7 @@
<argument index="0" name="torque" type="Vector3">
</argument>
<description>
+ Adds a constant rotational force (i.e. a motor) without affecting position.
</description>
</method>
<method name="apply_central_impulse">
@@ -56,6 +60,8 @@
<argument index="0" name="impulse" type="Vector3">
</argument>
<description>
+ Applies a single directional impulse without affecting rotation.
+ This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``.
</description>
</method>
<method name="apply_impulse">
diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml
index fcd01bc25a..d31da20f07 100644
--- a/doc/classes/Shape.xml
+++ b/doc/classes/Shape.xml
@@ -13,6 +13,10 @@
</demos>
<methods>
</methods>
+ <members>
+ <member name="margin" type="float" setter="set_margin" getter="get_margin">
+ </member>
+ </members>
<constants>
</constants>
</class>
diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml
index 4f48889531..354c6686bb 100644
--- a/doc/classes/SpatialMaterial.xml
+++ b/doc/classes/SpatialMaterial.xml
@@ -64,12 +64,12 @@
</member>
<member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV">
</member>
- <member name="distance_fade_enable" type="bool" setter="set_distance_fade" getter="is_distance_fade_enabled">
- </member>
<member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance">
</member>
<member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance">
</member>
+ <member name="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="SpatialMaterial.DistanceFadeMode">
+ </member>
<member name="emission" type="Color" setter="set_emission" getter="get_emission">
</member>
<member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature">
@@ -376,5 +376,13 @@
</constant>
<constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator">
</constant>
+ <constant name="DISTANCE_FADE_DISABLED" value="0" enum="DistanceFadeMode">
+ </constant>
+ <constant name="DISTANCE_FADE_PIXEL_ALPHA" value="1" enum="DistanceFadeMode">
+ </constant>
+ <constant name="DISTANCE_FADE_PIXEL_DITHER" value="2" enum="DistanceFadeMode">
+ </constant>
+ <constant name="DISTANCE_FADE_OBJECT_DITHER" value="3" enum="DistanceFadeMode">
+ </constant>
</constants>
</class>
diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml
index dd7fe010ba..52650c7300 100644
--- a/doc/classes/Sprite.xml
+++ b/doc/classes/Sprite.xml
@@ -18,6 +18,14 @@
Returns a Rect2 representing the Sprite's boundary relative to its local coordinates.
</description>
</method>
+ <method name="is_pixel_opaque" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="pos" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
</methods>
<members>
<member name="centered" type="bool" setter="set_centered" getter="is_centered">
diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml
index 73d60e49b7..49549a9892 100644
--- a/doc/classes/TileMap.xml
+++ b/doc/classes/TileMap.xml
@@ -157,16 +157,6 @@
If you need these to be immediately updated, you can call [method update_dirty_quadrants].
</description>
</method>
- <method name="set_celld">
- <return type="void">
- </return>
- <argument index="0" name="position" type="Vector2">
- </argument>
- <argument index="1" name="data" type="Dictionary">
- </argument>
- <description>
- </description>
- </method>
<method name="set_cellv">
<return type="void">
</return>
diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index 56bb33c5e1..a30d12d6b7 100644
--- a/doc/classes/TileSet.xml
+++ b/doc/classes/TileSet.xml
@@ -215,6 +215,16 @@
<description>
</description>
</method>
+ <method name="tile_get_shape_offset" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <argument index="1" name="shape_id" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="tile_get_shape_one_way" qualifiers="const">
<return type="bool">
</return>
@@ -389,6 +399,18 @@
<description>
</description>
</method>
+ <method name="tile_set_shape_offset">
+ <return type="void">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <argument index="1" name="shape_id" type="int">
+ </argument>
+ <argument index="2" name="shape_offset" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="tile_set_shape_one_way">
<return type="void">
</return>
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml
index 0ea5c6e005..0ea5c6e005 100755..100644
--- a/doc/classes/UndoRedo.xml
+++ b/doc/classes/UndoRedo.xml
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml
index 05649193a6..2f5710da51 100644
--- a/doc/classes/Viewport.xml
+++ b/doc/classes/Viewport.xml
@@ -104,6 +104,12 @@
Returns [code]true[/code] if there are visible modals on-screen.
</description>
</method>
+ <method name="gui_is_dragging" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="input">
<return type="void">
</return>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-12 20:35:51 +0000