Browse Source

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.
Ryan Roden-Corrent 6 years ago
parent
commit
b1c221d5ab
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/MultiMesh.xml

+ 1 - 0
doc/classes/MultiMesh.xml

@@ -65,6 +65,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Set the color of a specific instance.
 				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>
 			</description>
 		</method>
 		</method>
 		<method name="set_instance_custom_data">
 		<method name="set_instance_custom_data">