summaryrefslogtreecommitdiff
path: root/doc/classes/LightmapGIData.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-08 22:50:35 +0200
committerGitHub <noreply@github.com>2022-08-08 22:50:35 +0200
commit682dbe5d00aa7730659771b16704eba83f166a7b (patch)
tree8555e07c3bfb3b2892d530bc93fbf47d14519e35 /doc/classes/LightmapGIData.xml
parentd9d5990c517b63f41881de05cb4644c36e0c77e0 (diff)
parentc5d7115038de5f83cb83e08748615a84fc26bee2 (diff)
Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntax
Diffstat (limited to 'doc/classes/LightmapGIData.xml')
-rw-r--r--doc/classes/LightmapGIData.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/LightmapGIData.xml b/doc/classes/LightmapGIData.xml
index 13f44150d7..0881d3de8a 100644
--- a/doc/classes/LightmapGIData.xml
+++ b/doc/classes/LightmapGIData.xml
@@ -11,10 +11,10 @@
<methods>
<method name="add_user">
<return type="void" />
- <argument index="0" name="path" type="NodePath" />
- <argument index="1" name="uv_scale" type="Rect2" />
- <argument index="2" name="slice_index" type="int" />
- <argument index="3" name="sub_instance" type="int" />
+ <param index="0" name="path" type="NodePath" />
+ <param index="1" name="uv_scale" type="Rect2" />
+ <param index="2" name="slice_index" type="int" />
+ <param index="3" name="sub_instance" type="int" />
<description>
Adds an object that is considered baked within this [LightmapGIData].
</description>
@@ -33,7 +33,7 @@
</method>
<method name="get_user_path" qualifiers="const">
<return type="NodePath" />
- <argument index="0" name="user_idx" type="int" />
+ <param index="0" name="user_idx" type="int" />
<description>
Returns the [NodePath] of the baked object at index [code]user_idx[/code].
</description>
@@ -46,7 +46,7 @@
</method>
<method name="set_uses_spherical_harmonics">
<return type="void" />
- <argument index="0" name="uses_spherical_harmonics" type="bool" />
+ <param index="0" name="uses_spherical_harmonics" type="bool" />
<description>
If [code]uses_spherical_harmonics[/code] is [code]true[/code], tells the engine to treat the lightmap data as if it was baked with directional information.
[b]Note:[/b] Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire [LightmapGIData] resource is replaced by the lightmapper.