Cleanup: Clarification of the Particle.uv_on_emitter() function docs

Just some rewording of the documentation of `Particle.uv_on_emitter()`,
so that it no longer refers to 'derived mesh' but 'evaluated mesh', and
document that it expects a modifier from an evaluated object.

No functional changes.
This commit is contained in:
Sybren A. Stüvel 2020-01-16 14:54:55 +01:00
parent 3c426feb12
commit 59589457a5

@ -1768,9 +1768,14 @@ static void rna_def_particle(BlenderRNA *brna)
/* UVs */
func = RNA_def_function(srna, "uv_on_emitter", "rna_Particle_uv_on_emitter");
RNA_def_function_ui_description(func, "Obtain uv for particle on derived mesh");
RNA_def_function_ui_description(func,
"Obtain UV coordinates for a particle on an evaluated mesh.");
RNA_def_function_flag(func, FUNC_USE_REPORTS);
parm = RNA_def_pointer(func, "modifier", "ParticleSystemModifier", "", "Particle modifier");
parm = RNA_def_pointer(func,
"modifier",
"ParticleSystemModifier",
"",
"Particle modifier from an evaluated object");
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
parm = RNA_def_property(func, "uv", PROP_FLOAT, PROP_COORDS);
RNA_def_property_array(parm, 2);