diff options
| author | clayjohn <claynjohn@gmail.com> | 2020-01-30 17:18:09 -0800 |
|---|---|---|
| committer | clayjohn <claynjohn@gmail.com> | 2020-03-30 16:53:07 -0700 |
| commit | 3362e81674e2c149fe326430ff414ae344d26e19 (patch) | |
| tree | 6219cdc7f10179efbf993e12e432046a714d3d6e /doc/classes | |
| parent | dfed5efea3b5646cfca6662e52cf20c54558eb42 (diff) | |
Add a method to retrieve active material from MeshInstance
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/MeshInstance3D.xml | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml index 9276c5dc65..c569da2df1 100644 --- a/doc/classes/MeshInstance3D.xml +++ b/doc/classes/MeshInstance3D.xml @@ -4,7 +4,7 @@ Node that instances meshes into a scenario. </brief_description> <description> - MeshInstance3D is a node that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance3D] instead. + MeshInstance3D is a node that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used render 3D geometry and can be used to instance a single [Mesh] in many places. This allows reuse of geometry which can save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance3D] instead. </description> <tutorials> </tutorials> @@ -30,13 +30,22 @@ This helper creates a [StaticBody3D] child node with a [ConcavePolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> + <method name="get_active_material" qualifiers="const"> + <return type="Material"> + </return> + <argument index="0" name="surface" type="int"> + </argument> + <description> + Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material. + </description> + </method> <method name="get_surface_material" qualifiers="const"> <return type="Material"> </return> <argument index="0" name="surface" type="int"> </argument> <description> - Returns the [Material] for a surface of the [Mesh] resource. + Returns the override [Material] for the specified surface of the [Mesh] resource. </description> </method> <method name="get_surface_material_count" qualifiers="const"> @@ -54,7 +63,7 @@ <argument index="1" name="material" type="Material"> </argument> <description> - Sets the [Material] for a surface of the [Mesh] resource. + Sets the override [Material] for the specified surface of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with the [Mesh] resource. </description> </method> </methods> |