From d22791c271aceeade16970bffd8e8a3a146de339 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 12 Oct 2020 10:57:54 +0200 Subject: doc: Sync classref with current source --- doc/classes/Callable.xml | 14 ++++++++ doc/classes/GPUParticles3D.xml | 2 ++ doc/classes/GPUParticlesAttractor3D.xml | 23 +++++++++++++ doc/classes/GPUParticlesAttractorBox.xml | 17 ++++++++++ doc/classes/GPUParticlesAttractorSphere.xml | 17 ++++++++++ doc/classes/GPUParticlesAttractorVectorField.xml | 19 +++++++++++ doc/classes/GPUParticlesCollision3D.xml | 17 ++++++++++ doc/classes/GPUParticlesCollisionBox.xml | 17 ++++++++++ doc/classes/GPUParticlesCollisionHeightField.xml | 43 ++++++++++++++++++++++++ doc/classes/GPUParticlesCollisionSDF.xml | 37 ++++++++++++++++++++ doc/classes/GPUParticlesCollisionSphere.xml | 17 ++++++++++ doc/classes/ParticlesMaterial.xml | 10 ++++++ doc/classes/RenderingServer.xml | 14 ++++---- 13 files changed, 241 insertions(+), 6 deletions(-) create mode 100644 doc/classes/GPUParticlesAttractor3D.xml create mode 100644 doc/classes/GPUParticlesAttractorBox.xml create mode 100644 doc/classes/GPUParticlesAttractorSphere.xml create mode 100644 doc/classes/GPUParticlesAttractorVectorField.xml create mode 100644 doc/classes/GPUParticlesCollision3D.xml create mode 100644 doc/classes/GPUParticlesCollisionBox.xml create mode 100644 doc/classes/GPUParticlesCollisionHeightField.xml create mode 100644 doc/classes/GPUParticlesCollisionSDF.xml create mode 100644 doc/classes/GPUParticlesCollisionSphere.xml (limited to 'doc/classes') diff --git a/doc/classes/Callable.xml b/doc/classes/Callable.xml index 3bbee993ac..ad5c549fee 100644 --- a/doc/classes/Callable.xml +++ b/doc/classes/Callable.xml @@ -47,6 +47,12 @@ Creates a new [Callable] for the method called [code]method_name[/code] in the specified [code]object[/code]. + + + + + + @@ -106,6 +112,14 @@ + + + + + + + + diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index e840e457bf..d1296c3418 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -67,6 +67,8 @@ Number of particles to emit. + + Particle draw order. Uses [enum DrawOrder] values. diff --git a/doc/classes/GPUParticlesAttractor3D.xml b/doc/classes/GPUParticlesAttractor3D.xml new file mode 100644 index 0000000000..111827d294 --- /dev/null +++ b/doc/classes/GPUParticlesAttractor3D.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesAttractorBox.xml b/doc/classes/GPUParticlesAttractorBox.xml new file mode 100644 index 0000000000..68616f9bbd --- /dev/null +++ b/doc/classes/GPUParticlesAttractorBox.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesAttractorSphere.xml b/doc/classes/GPUParticlesAttractorSphere.xml new file mode 100644 index 0000000000..6984427a96 --- /dev/null +++ b/doc/classes/GPUParticlesAttractorSphere.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesAttractorVectorField.xml b/doc/classes/GPUParticlesAttractorVectorField.xml new file mode 100644 index 0000000000..cf5e375ea3 --- /dev/null +++ b/doc/classes/GPUParticlesAttractorVectorField.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesCollision3D.xml b/doc/classes/GPUParticlesCollision3D.xml new file mode 100644 index 0000000000..dce9a32fc4 --- /dev/null +++ b/doc/classes/GPUParticlesCollision3D.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesCollisionBox.xml b/doc/classes/GPUParticlesCollisionBox.xml new file mode 100644 index 0000000000..17fc124c41 --- /dev/null +++ b/doc/classes/GPUParticlesCollisionBox.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesCollisionHeightField.xml b/doc/classes/GPUParticlesCollisionHeightField.xml new file mode 100644 index 0000000000..c6987515a9 --- /dev/null +++ b/doc/classes/GPUParticlesCollisionHeightField.xml @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesCollisionSDF.xml b/doc/classes/GPUParticlesCollisionSDF.xml new file mode 100644 index 0000000000..c3cbe4b1c6 --- /dev/null +++ b/doc/classes/GPUParticlesCollisionSDF.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticlesCollisionSphere.xml b/doc/classes/GPUParticlesCollisionSphere.xml new file mode 100644 index 0000000000..41150960d2 --- /dev/null +++ b/doc/classes/GPUParticlesCollisionSphere.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index f6fa3cf38b..77df6245e9 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -131,6 +131,16 @@ Animation speed randomness ratio. + + + + + + + + + + Each particle's initial color. If the [GPUParticles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. To have particle display color in a [BaseMaterial3D] make sure to set [member BaseMaterial3D.vertex_color_use_as_albedo] to [code]true[/code]. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 9ca699501f..456022a626 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -3579,22 +3579,24 @@ The instance is a particle emitter. - + + + The instance is a light. - + The instance is a reflection probe. - + The instance is a decal. - + The instance is a GI probe. - + The instance is a lightmap. - + Represents the size of the [enum InstanceType] enum. -- cgit v1.2.3