diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/CPUParticles3D.xml | 19 | ||||
| -rw-r--r-- | doc/classes/Camera2D.xml | 16 | ||||
| -rw-r--r-- | doc/classes/Camera3D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/LineEdit.xml | 7 | ||||
| -rw-r--r-- | doc/classes/MultiplayerAPI.xml | 9 | ||||
| -rw-r--r-- | doc/classes/ParticlesMaterial.xml | 17 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 4 | ||||
| -rw-r--r-- | doc/classes/RenderingServer.xml | 36 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 11 | ||||
| -rw-r--r-- | doc/classes/TileMap.xml | 6 | ||||
| -rw-r--r-- | doc/classes/TileSet.xml | 156 | ||||
| -rw-r--r-- | doc/classes/Viewport.xml | 11 |
12 files changed, 263 insertions, 33 deletions
diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index d7a89eef11..29e04dda7e 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -177,9 +177,21 @@ <member name="emission_normals" type="PackedVector3Array" setter="set_emission_normals" getter="get_emission_normals"> Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS]. </member> - <member name="emission_points" type="PackedVector3Array" setter="set_emission_points" getter="get_emission_points" default="PackedVector3Array()"> + <member name="emission_points" type="PackedVector3Array" setter="set_emission_points" getter="get_emission_points"> Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. </member> + <member name="emission_ring_axis" type="Vector3" setter="set_emission_ring_axis" getter="get_emission_ring_axis"> + The axis of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_height" type="float" setter="set_emission_ring_height" getter="get_emission_ring_height"> + The height of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_inner_radius" type="float" setter="set_emission_ring_inner_radius" getter="get_emission_ring_inner_radius"> + The inner radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_radius" type="float" setter="set_emission_ring_radius" getter="get_emission_ring_radius"> + The radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles3D.EmissionShape" default="0"> Particles will be emitted inside this region. See [enum EmissionShape] for possible values. </member> @@ -378,7 +390,10 @@ <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> 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> - <constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_RING" value="5" enum="EmissionShape"> + Particles will be emitted in a ring or cylinder. + </constant> + <constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape"> Represents the size of the [enum EmissionShape] enum. </constant> </constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 4620b3d93c..e8f4cb49b6 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -21,13 +21,6 @@ Aligns the camera to the tracked node. </description> </method> - <method name="clear_current"> - <return type="void"> - </return> - <description> - Removes any [Camera2D] from the ancestor [Viewport]'s internal currently-assigned camera. - </description> - </method> <method name="force_update_scroll"> <return type="void"> </return> @@ -67,13 +60,6 @@ Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. </description> </method> - <method name="make_current"> - <return type="void"> - </return> - <description> - Make this the current 2D camera for the scene (viewport and layer), in case there are many cameras in the scene. - </description> - </method> <method name="reset_smoothing"> <return type="void"> </return> @@ -109,7 +95,7 @@ <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1"> The Camera2D's anchor point. See [enum AnchorMode] constants. </member> - <member name="current" type="bool" setter="_set_current" getter="is_current" default="false"> + <member name="current" type="bool" setter="set_current" getter="is_current" default="false"> If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. </member> <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index afba478a20..0f0bfdc654 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -176,8 +176,8 @@ [codeblock] # This code block is part of a script that inherits from Node3D. # `control` is a reference to a node inheriting from Control. - control.visible = not get_viewport().get_camera().is_position_behind(global_transform.origin) - control.rect_position = get_viewport().get_camera().unproject_position(global_transform.origin) + control.visible = not get_viewport().get_camera_3d().is_position_behind(global_transform.origin) + control.rect_position = get_viewport().get_camera_3d().unproject_position(global_transform.origin) [/codeblock] </description> </method> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 773f7b1a02..af6fc738c7 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -102,6 +102,13 @@ Inserts [code]text[/code] at the caret. If the resulting value is longer than [member max_length], nothing happens. </description> </method> + <method name="is_menu_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided). + </description> + </method> <method name="menu_option"> <return type="void"> </return> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index c4d8a5b1b9..82b929c1f7 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -146,14 +146,5 @@ <constant name="RPC_MODE_PUPPET" value="3" enum="RPCMode"> Used with [method Node.rpc_config] to set a method to be called or a property to be changed only on puppets for this node. Analogous to the [code]puppet[/code] keyword. Only accepts calls or property changes from the node's network master, see [method Node.set_network_master]. </constant> - <constant name="RPC_MODE_REMOTESYNC" value="4" enum="RPCMode"> - Behave like [constant RPC_MODE_REMOTE] but also make the call or property change locally. Analogous to the [code]remotesync[/code] keyword. - </constant> - <constant name="RPC_MODE_MASTERSYNC" value="5" enum="RPCMode"> - Behave like [constant RPC_MODE_MASTER] but also make the call or property change locally. Analogous to the [code]mastersync[/code] keyword. - </constant> - <constant name="RPC_MODE_PUPPETSYNC" value="6" enum="RPCMode"> - Behave like [constant RPC_MODE_PUPPET] but also make the call or property change locally. Analogous to the [code]puppetsync[/code] keyword. - </constant> </constants> </class> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 52430b3f45..640a26b8cb 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -174,6 +174,18 @@ <member name="emission_point_texture" type="Texture2D" setter="set_emission_point_texture" getter="get_emission_point_texture"> Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. </member> + <member name="emission_ring_axis" type="Vector3" setter="set_emission_ring_axis" getter="get_emission_ring_axis"> + The axis of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_height" type="float" setter="set_emission_ring_height" getter="get_emission_ring_height"> + The height of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_inner_radius" type="float" setter="set_emission_ring_inner_radius" getter="get_emission_ring_inner_radius"> + The inner radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> + <member name="emission_ring_radius" type="float" setter="set_emission_ring_radius" getter="get_emission_ring_radius"> + The radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. + </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0"> Particles will be emitted inside this region. Use [enum EmissionShape] constants for values. </member> @@ -338,7 +350,10 @@ <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]. </constant> - <constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_RING" value="5" enum="EmissionShape"> + Particles will be emitted in a ring or cylinder. + </constant> + <constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape"> Represents the size of the [enum EmissionShape] enum. </constant> <constant name="SUB_EMITTER_DISABLED" value="0" enum="SubEmitterMode"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index fbd257cdba..c3ef9f2425 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1569,12 +1569,16 @@ <member name="rendering/shadows/shadows/soft_shadow_quality.mobile" type="int" setter="" getter="" default="0"> Lower-end override for [member rendering/shadows/shadows/soft_shadow_quality] on mobile devices, due to performance concerns or driver support. </member> + <member name="rendering/textures/decals/filter" type="int" setter="" getter="" default="3"> + </member> <member name="rendering/textures/default_filters/anisotropic_filtering_level" type="int" setter="" getter="" default="2"> Sets the maximum number of samples to take when using anisotropic filtering on textures (as a power of two). A higher sample count will result in sharper textures at oblique angles, but is more expensive to compute. A value of [code]0[/code] forcibly disables anisotropic filtering, even on materials where it is enabled. </member> <member name="rendering/textures/default_filters/use_nearest_mipmap_filter" type="bool" setter="" getter="" default="false"> If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used. </member> + <member name="rendering/textures/light_projectors/filter" type="int" setter="" getter="" default="3"> + </member> <member name="rendering/textures/lossless_compression/force_png" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP. </member> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 6b45653bf2..31ced67ac4 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1209,6 +1209,14 @@ <description> </description> </method> + <method name="decals_set_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="int" enum="RenderingServer.DecalFilter"> + </argument> + <description> + </description> + </method> <method name="directional_light_create"> <return type="RID"> </return> @@ -2153,6 +2161,14 @@ Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to [member OmniLight3D.omni_shadow_mode]. </description> </method> + <method name="light_projectors_set_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter"> + </argument> + <description> + </description> + </method> <method name="light_set_bake_mode"> <return type="void"> </return> @@ -4865,6 +4881,16 @@ <constant name="MULTIMESH_TRANSFORM_3D" value="1" enum="MultimeshTransformFormat"> Use [Transform3D] to store MultiMesh transform. </constant> + <constant name="LIGHT_PROJECTOR_FILTER_NEAREST" value="0" enum="LightProjectorFilter"> + </constant> + <constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS" value="1" enum="LightProjectorFilter"> + </constant> + <constant name="LIGHT_PROJECTOR_FILTER_LINEAR" value="2" enum="LightProjectorFilter"> + </constant> + <constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS" value="3" enum="LightProjectorFilter"> + </constant> + <constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="LightProjectorFilter"> + </constant> <constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType"> Is a directional (sun) light. </constant> @@ -4986,6 +5012,16 @@ </constant> <constant name="DECAL_TEXTURE_MAX" value="4" enum="DecalTexture"> </constant> + <constant name="DECAL_FILTER_NEAREST" value="0" enum="DecalFilter"> + </constant> + <constant name="DECAL_FILTER_NEAREST_MIPMAPS" value="1" enum="DecalFilter"> + </constant> + <constant name="DECAL_FILTER_LINEAR" value="2" enum="DecalFilter"> + </constant> + <constant name="DECAL_FILTER_LINEAR_MIPMAPS" value="3" enum="DecalFilter"> + </constant> + <constant name="DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="DecalFilter"> + </constant> <constant name="VOXEL_GI_QUALITY_LOW" value="0" enum="VoxelGIQuality"> </constant> <constant name="VOXEL_GI_QUALITY_HIGH" value="1" enum="VoxelGIQuality"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 5de6c059c3..e51bf42bdb 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -382,6 +382,13 @@ <description> </description> </method> + <method name="is_menu_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided). + </description> + </method> <method name="is_selection_active" qualifiers="const"> <return type="bool"> </return> @@ -851,9 +858,9 @@ </constant> <constant name="GUTTER_TYPE_STRING" value="0" enum="GutterType"> </constant> - <constant name="GUTTER_TPYE_ICON" value="1" enum="GutterType"> + <constant name="GUTTER_TYPE_ICON" value="1" enum="GutterType"> </constant> - <constant name="GUTTER_TPYE_CUSTOM" value="2" enum="GutterType"> + <constant name="GUTTER_TYPE_CUSTOM" value="2" enum="GutterType"> </constant> <constant name="MENU_CUT" value="0" enum="MenuItems"> Cuts (copies and clears) the selected text. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 5a4068ec86..e6f696d27c 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -36,6 +36,8 @@ </return> <argument index="0" name="coords" type="Vector2i"> </argument> + <argument index="1" name="use_proxies" type="bool"> + </argument> <description> </description> </method> @@ -44,6 +46,8 @@ </return> <argument index="0" name="coords" type="Vector2i"> </argument> + <argument index="1" name="use_proxies" type="bool"> + </argument> <description> </description> </method> @@ -52,6 +56,8 @@ </return> <argument index="0" name="coords" type="Vector2i"> </argument> + <argument index="1" name="use_proxies" type="bool"> + </argument> <description> </description> </method> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 436e15387d..8185b09a30 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -27,6 +27,40 @@ <description> </description> </method> + <method name="cleanup_invalid_tile_proxies"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_tile_proxies"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_alternative_level_tile_proxy"> + <return type="Array"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="alternative_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_coords_level_tile_proxy"> + <return type="Array"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <description> + </description> + </method> <method name="get_navigation_layer_layers" qualifiers="const"> <return type="int"> </return> @@ -103,6 +137,14 @@ <description> </description> </method> + <method name="get_source_level_tile_proxy"> + <return type="int"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <description> + </description> + </method> <method name="get_terrain_color" qualifiers="const"> <return type="Color"> </return> @@ -139,6 +181,28 @@ <description> </description> </method> + <method name="has_alternative_level_tile_proxy"> + <return type="bool"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="alternative_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_coords_level_tile_proxy"> + <return type="bool"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <description> + </description> + </method> <method name="has_source" qualifiers="const"> <return type="bool"> </return> @@ -147,6 +211,48 @@ <description> </description> </method> + <method name="has_source_level_tile_proxy"> + <return type="bool"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="map_tile_proxy" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="alternative_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_alternative_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="alternative_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_coords_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <description> + </description> + </method> <method name="remove_source"> <return type="void"> </return> @@ -155,6 +261,46 @@ <description> </description> </method> + <method name="remove_source_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_alternative_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="alternative_from" type="int"> + </argument> + <argument index="3" name="source_to" type="int"> + </argument> + <argument index="4" name="coords_to" type="Vector2i"> + </argument> + <argument index="5" name="alternative_to" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_coords_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="p_source_from" type="int"> + </argument> + <argument index="1" name="coords_from" type="Vector2i"> + </argument> + <argument index="2" name="source_to" type="int"> + </argument> + <argument index="3" name="coords_to" type="Vector2i"> + </argument> + <description> + </description> + </method> <method name="set_navigation_layer_layers"> <return type="void"> </return> @@ -225,6 +371,16 @@ <description> </description> </method> + <method name="set_source_level_tile_proxy"> + <return type="void"> + </return> + <argument index="0" name="source_from" type="int"> + </argument> + <argument index="1" name="source_to" type="int"> + </argument> + <description> + </description> + </method> <method name="set_terrain_color"> <return type="void"> </return> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 00827fe324..bf58dc4d8c 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -36,11 +36,18 @@ Returns the 3D world of the viewport, or if none the world of the parent viewport. </description> </method> - <method name="get_camera" qualifiers="const"> + <method name="get_camera_2d" qualifiers="const"> + <return type="Camera2D"> + </return> + <description> + Returns the currently active 2D camera. Returns null if there are no active cameras. + </description> + </method> + <method name="get_camera_3d" qualifiers="const"> <return type="Camera3D"> </return> <description> - Returns the active 3D camera. + Returns the currently active 3D camera. </description> </method> <method name="get_final_transform" qualifiers="const"> |