diff options
| author | Jose Falanga <jose.falanga@gmail.com> | 2023-07-24 10:31:57 -0300 |
|---|---|---|
| committer | Jose Falanga <jose.falanga@gmail.com> | 2023-07-24 10:31:57 -0300 |
| commit | bf62fb059c5fba2def54f20cc1a38aa8c76e81d6 (patch) | |
| tree | b91c783b3a971fb98659ab9936979a90a3ad0aa3 | |
| parent | 0c2144da908a8223e188d27ed1d31d8248056c78 (diff) | |
| download | redot-engine-bf62fb059c5fba2def54f20cc1a38aa8c76e81d6.tar.gz | |
Clarify when the changed signal is emitted for Resource and ShaderMaterial
| -rw-r--r-- | doc/classes/Resource.xml | 2 | ||||
| -rw-r--r-- | doc/classes/ShaderMaterial.xml | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 83a878bada..2a2239f660 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -32,7 +32,7 @@ <method name="emit_changed"> <return type="void" /> <description> - Emits the [signal changed] signal. This method is called automatically for built-in resources. + Emits the [signal changed] signal. This method is called automatically for some built-in resources. [b]Note:[/b] For custom resources, it's recommended to call this method whenever a meaningful change occurs, such as a modified property. This ensures that custom [Object]s depending on the resource are properly updated. [codeblock] var damage: diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 888964e7f0..e2d0696a4b 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -5,6 +5,7 @@ </brief_description> <description> A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. + [b]Note:[/b] For performance reasons the [signal Resource.changed] signal is only emitted when the [member Resource.resource_name] is changed. Only in editor, is also emitted for [member shader] changes. </description> <tutorials> <link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link> |