diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Bone2D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/CPUParticles.xml | 13 | ||||
| -rw-r--r-- | doc/classes/CPUParticles2D.xml | 14 | ||||
| -rw-r--r-- | doc/classes/ClippedCamera.xml | 6 | ||||
| -rw-r--r-- | doc/classes/FileDialog.xml | 2 | ||||
| -rw-r--r-- | doc/classes/MeshInstance2D.xml | 6 | ||||
| -rw-r--r-- | doc/classes/MultiMeshInstance2D.xml | 6 |
8 files changed, 37 insertions, 16 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index eb612191e7..ba31a774fc 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1013,7 +1013,7 @@ Trigger on a VR controller </constant> <constant name="JOY_OCULUS_AX" value="7" enum="JoystickList"> - A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR) + A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR) </constant> <constant name="JOY_OCULUS_BY" value="1" enum="JoystickList"> B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR) diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 206853fe5f..757c6c6a34 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -4,7 +4,7 @@ Joint used with [Skeleton2D] to control and animate other nodes. </brief_description> <description> - Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [class Node2D] nodes. + Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [Node2D] nodes. You can use [code]Bone2D[/code] and [code]Skeleton2D[/code] nodes to animate 2D meshes created with the Polygon 2D UV editor. Each bone has a [member rest] transform that you can reset to with [method apply_rest]. These rest poses are relative to the bone's parent. If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses. @@ -39,7 +39,7 @@ Length of the bone's representation drawn in the editor's viewport in pixels. </member> <member name="rest" type="Transform2D" setter="set_rest" getter="get_rest"> - Rest transform of the bone. You can reset the node's transforms to this value using [member apply_rest]. + Rest transform of the bone. You can reset the node's transforms to this value using [method apply_rest]. </member> </members> <constants> diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 7ea9c61ff3..c9c92102f3 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -68,10 +68,10 @@ Animation speed randomness ratio. Default value: [code]0[/code]. </member> <member name="color" type="Color" setter="set_color" getter="get_color"> - Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. + Unused for 3D particles. </member> <member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp"> - Each particle's color will vary along this [Gradient]. + Unused for 3D particles. </member> <member name="damping" type="float" setter="set_param" getter="get_param"> The rate at which particles lose velocity. @@ -86,7 +86,7 @@ Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. </member> <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> - The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_BOX]. + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. </member> <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors"> </member> @@ -164,7 +164,8 @@ If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code]. </member> <member name="orbit_velocity" type="float" setter="set_param" getter="get_param"> - Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. + Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second. + This property is only available when [member flag_disable_z] is [code]true[/code]. </member> <member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> Each particle's orbital velocity will vary along this [Curve]. @@ -283,10 +284,10 @@ Particles will be emitted in the volume of a box. </constant> <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. </constant> <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. </constant> </constants> </class> diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index e045dd850f..4351a0b4d4 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -93,13 +93,13 @@ <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"> - The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_RECTANGLE]. + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape"> Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. </member> <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> - The circle's radius if [member emission_shape] is set to [const EMISSION_SHAPE_CIRCLE]. + The circle's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_CIRCLE]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. @@ -215,7 +215,7 @@ </constant> <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder"> Particles are drawn in order of remaining lifetime. - </constant + </constant> <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. </constant> @@ -259,10 +259,10 @@ Use with [method set_flag] to set [member flag_align_y]. </constant> <constant name="FLAG_ROTATE_Y" value="1" enum="Flags"> - Use with [method set_flag] to set [member flag_rotate_y]. Present for consistency with 3D particle nodes, not used in 2D. + Present for consistency with 3D particle nodes, not used in 2D. </constant> <constant name="FLAG_DISABLE_Z" value="2" enum="Flags"> - Use with [method set_flag] to set [member flag_disable_z]. Present for consistency with 3D particle nodes, not used in 2D. + Present for consistency with 3D particle nodes, not used in 2D. </constant> <constant name="FLAG_MAX" value="3" enum="Flags"> Represents the size of the [enum Flags] enum. @@ -277,10 +277,10 @@ Particles will be emitted in the area of a rectangle. </constant> <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. </constant> <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. </constant> </constants> </class> diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml index b7f158dd65..c6dcd6cd96 100644 --- a/doc/classes/ClippedCamera.xml +++ b/doc/classes/ClippedCamera.xml @@ -29,6 +29,12 @@ <description> </description> </method> + <method name="get_clip_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 953f364bdb..908c017ac9 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -138,5 +138,7 @@ </theme_item> <theme_item name="reload" type="Texture"> </theme_item> + <theme_item name="toggle_hidden" type="Texture"> + </theme_item> </theme_items> </class> diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml index 39a733fdb3..4b38b9aa96 100644 --- a/doc/classes/MeshInstance2D.xml +++ b/doc/classes/MeshInstance2D.xml @@ -22,6 +22,12 @@ The [Texture] that will be used if using the default [CanvasItemMaterial]. Can be accessed as [code]TEXTURE[/code] in CanvasItem shader. </member> </members> + <signals> + <signal name="texture_changed"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/MultiMeshInstance2D.xml b/doc/classes/MultiMeshInstance2D.xml index 0bf243ee24..8509986c3c 100644 --- a/doc/classes/MultiMeshInstance2D.xml +++ b/doc/classes/MultiMeshInstance2D.xml @@ -22,6 +22,12 @@ The [Texture] that will be used if using the default [CanvasItemMaterial]. Can be accessed as [code]TEXTURE[/code] in CanvasItem shader. </member> </members> + <signals> + <signal name="texture_changed"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> |