summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/CPUParticles3D.xml19
-rw-r--r--doc/classes/ParticlesMaterial.xml17
-rw-r--r--doc/classes/TileMap.xml6
-rw-r--r--doc/classes/TileSet.xml156
4 files changed, 195 insertions, 3 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/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/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>