From b1c221d5aba12d9a8fde4026273ffe03a35275fc Mon Sep 17 00:00:00 2001
From: Ryan Roden-Corrent <ryan@rcorre.net>
Date: Tue, 26 Feb 2019 21:41:22 -0500
Subject: 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.
---
 doc/classes/MultiMesh.xml | 1 +
 1 file changed, 1 insertion(+)

(limited to 'doc')

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">
-- 
cgit v1.2.3