Skip to content

Commit

Permalink
Update documentation of Object3D#userData (mrdoob#26799)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
tim-we authored Sep 18, 2023
1 parent 0b0a7d7 commit 75b9699
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/en/core/BufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ <h3>[property:Object userData]</h3>
<p>
An object that can be used to store custom data about the BufferGeometry.
It should not hold references to functions as these will not be cloned.
Default is an empty object `{}`.
</p>

<h3>[property:String uuid]</h3>
Expand Down
1 change: 1 addition & 0 deletions docs/api/en/core/Object3D.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ <h3>[property:Object userData]</h3>
<p>
An object that can be used to store custom data about the Object3D. It
should not hold references to functions as these will not be cloned.
Default is an empty object `{}`.
</p>

<h3>[property:String uuid]</h3>
Expand Down
1 change: 1 addition & 0 deletions docs/api/en/materials/Material.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ <h3>[property:Object userData]</h3>
<p>
An object that can be used to store custom data about the Material. It
should not hold references to functions as these will not be cloned.
Default is an empty object `{}`.
</p>

<h2>Methods</h2>
Expand Down
1 change: 1 addition & 0 deletions docs/api/en/textures/Texture.html
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ <h3>[property:Object userData]</h3>
<p>
An object that can be used to store custom data about the texture. It
should not hold references to functions as these will not be cloned.
Default is an empty object `{}`.
</p>

<h3>[property:Source source]</h3>
Expand Down

0 comments on commit 75b9699

Please sign in to comment.