Skip to content

Commit 75b9699

Browse files
authored
Update documentation of Object3D#userData (#26799)
* Update userData description in Object3D.html Updated the documentation to make clear what the default value is (otherwise one could assume it might be null or undefined). * Update Texture.html * Update Material.html * Update BufferGeometry.html
1 parent 0b0a7d7 commit 75b9699

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

docs/api/en/core/BufferGeometry.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ <h3>[property:Object userData]</h3>
191191
<p>
192192
An object that can be used to store custom data about the BufferGeometry.
193193
It should not hold references to functions as these will not be cloned.
194+
Default is an empty object `{}`.
194195
</p>
195196

196197
<h3>[property:String uuid]</h3>

docs/api/en/core/Object3D.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ <h3>[property:Object userData]</h3>
206206
<p>
207207
An object that can be used to store custom data about the Object3D. It
208208
should not hold references to functions as these will not be cloned.
209+
Default is an empty object `{}`.
209210
</p>
210211

211212
<h3>[property:String uuid]</h3>

docs/api/en/materials/Material.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,7 @@ <h3>[property:Object userData]</h3>
369369
<p>
370370
An object that can be used to store custom data about the Material. It
371371
should not hold references to functions as these will not be cloned.
372+
Default is an empty object `{}`.
372373
</p>
373374

374375
<h2>Methods</h2>

docs/api/en/textures/Texture.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@ <h3>[property:Object userData]</h3>
281281
<p>
282282
An object that can be used to store custom data about the texture. It
283283
should not hold references to functions as these will not be cloned.
284+
Default is an empty object `{}`.
284285
</p>
285286

286287
<h3>[property:Source source]</h3>

0 commit comments

Comments
 (0)