asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Clarify when the changed signal is emitted for Resource and ShaderMaterial

Browse source
This commit is contained in:
Jose Falanga 2023-07-24 10:31:57 -03:00
parent 0c2144da90
commit bf62fb059c
2 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Resource.xml
View file

@ -32,7 +32,7 @@
<method name="emit_changed"> <method name="emit_changed">
<return type="void" /> <return type="void" />
<description> <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. [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] [codeblock]
var damage: var damage:

1
doc/classes/ShaderMaterial.xml
View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<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. 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> </description>
<tutorials> <tutorials>
<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link> <link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link>