summaryrefslogtreecommitdiff
path: root/doc/classes/MultiMesh.xml
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2019-02-26 21:41:22 -0500
committerRyan Roden-Corrent <ryan@rcorre.net>2019-02-26 21:41:22 -0500
commitb1c221d5aba12d9a8fde4026273ffe03a35275fc (patch)
tree76e18d71401046356e0a62f37ff14978ff5ba095 /doc/classes/MultiMesh.xml
parentffb9f342a52186b7fb7da4607af524786fea829e (diff)
Clarify how to use MultiMesh.set_instance_color.
Just calling set_instance_color will do nothing unless you have set color_format and vertex_color_use_as_albedo. This is really confusing, and I only discovered my error by finding godotengine/godot#10217 from another confused user. The docs should call out these requirements.
Diffstat (limited to 'doc/classes/MultiMesh.xml')
-rw-r--r--doc/classes/MultiMesh.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml
index 565e19c229..0cc9764e36 100644
--- a/doc/classes/MultiMesh.xml
+++ b/doc/classes/MultiMesh.xml
@@ -65,6 +65,7 @@
</argument>
<description>
Set the color of a specific instance.
+ For the color to take effect, ensure that [member color_format] is non-[code]null[/code] on the [code]MultiMesh[/code] and [member SpatialMaterial.vertex_color_use_as_albedo] is [code]true[/code] on the material.
</description>
</method>
<method name="set_instance_custom_data">