Add information about emit_particle in GPUParticles3D's docs
#110771
+1
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AThousandShips
changed the title
emit_particle in GPUParticles3D's docs
AThousandShips
added
enhancement
documentation
cherrypick:4.4
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
|
build error seems unrelated |
Calinou
reviewed
Sep 23, 2025
| Emits a single particle. Whether [param xform], [param velocity], [param color] and [param custom] are applied depends on the value of [param flags]. See [enum EmitFlags]. | ||
| The default ParticleProcessMaterial will overwrite [param color] and use the contents of [param custom] as [code](rotation, age, animation, lifetime)[/code]. | ||
| [b]Note:[/b] [method emit_particle] is only supported on the Forward+ and Mobile rendering methods, not Compatibility. | ||
| [b]Note:[/b] A custom processing material shader that doesn't modify the transform is required for the [constant EMIT_FLAG_ROTATION_SCALE] flag to work correctly. |
There was a problem hiding this comment.
I think this is more explicit:
Suggested change
| [b]Note:[/b] A custom processing material shader that doesn't modify the transform is required for the [constant EMIT_FLAG_ROTATION_SCALE] flag to work correctly. | |
| [b]Note:[/b] A custom particle shader that doesn't modify the transform is required for the [constant EMIT_FLAG_ROTATION_SCALE] flag to work correctly. |
"Particle shader" refers to what controls the particles, where "material shader" may be understood as the rendering (BaseMaterial3D) shader.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added a short text explaining non-obvious functionality.