From 201335f3ece1118cdf23fe28a04996e4f223642f Mon Sep 17 00:00:00 2001
From: aXu-AP <1621768+aXu-AP@users.noreply.github.com>
Date: Mon, 23 Jan 2023 23:16:35 +0200
Subject: Add documentation for GpuParticles2D collisions
---
doc/classes/GPUParticles2D.xml | 4 +++-
doc/classes/ParticleProcessMaterial.xml | 3 ++-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml
index c7d10078e8..29779e4a77 100644
--- a/doc/classes/GPUParticles2D.xml
+++ b/doc/classes/GPUParticles2D.xml
@@ -5,7 +5,8 @@
2D particle node used to create a variety of particle systems and effects. [GPUParticles2D] features an emitter that generates some number of particles at a given rate.
- Use the [code]process_material[/code] property to add a [ParticleProcessMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.
+ Use the [member process_material] property to add a [ParticleProcessMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.
+ 2D particles can optionally collide with [LightOccluder2D] nodes (note: they don't collide with [PhysicsBody2D] nodes).
$DOCS_URL/tutorials/2d/particle_systems_2d.html
@@ -42,6 +43,7 @@
Number of particles emitted in one emission cycle.
+ Multiplier for particle's collision radius. [code]1.0[/code] corresponds to the size of the sprite.
Particle draw order. Uses [enum DrawOrder] values.
diff --git a/doc/classes/ParticleProcessMaterial.xml b/doc/classes/ParticleProcessMaterial.xml
index d4050e3bd1..d046d52ed1 100644
--- a/doc/classes/ParticleProcessMaterial.xml
+++ b/doc/classes/ParticleProcessMaterial.xml
@@ -123,7 +123,8 @@
The particles' collision mode.
- [b]Note:[/b] Particles can only collide with [GPUParticlesCollision3D] nodes, not [PhysicsBody3D] nodes. To make particles collide with various objects, you can add [GPUParticlesCollision3D] nodes as children of [PhysicsBody3D] nodes.
+ [b]Note:[/b] 3D Particles can only collide with [GPUParticlesCollision3D] nodes, not [PhysicsBody3D] nodes. To make particles collide with various objects, you can add [GPUParticlesCollision3D] nodes as children of [PhysicsBody3D] nodes.
+ [b]Note:[/b] 2D Particles can only collide with [LightOccluder2D] nodes, not [PhysicsBody2D] nodes.
Should collision take scale into account.
--
cgit v1.2.3