From 75b9699196f46153bd371de52380d0829dd67beb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20Wei=C3=9Fenfels?= <10491533+tim-we@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:01:06 +0200 Subject: [PATCH] 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 --- docs/api/en/core/BufferGeometry.html | 1 + docs/api/en/core/Object3D.html | 1 + docs/api/en/materials/Material.html | 1 + docs/api/en/textures/Texture.html | 1 + 4 files changed, 4 insertions(+) diff --git a/docs/api/en/core/BufferGeometry.html b/docs/api/en/core/BufferGeometry.html index b4ff4e2ce6081b..43630ef3bf4acb 100644 --- a/docs/api/en/core/BufferGeometry.html +++ b/docs/api/en/core/BufferGeometry.html @@ -191,6 +191,7 @@

[property:Object userData]

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 `{}`.

[property:String uuid]

diff --git a/docs/api/en/core/Object3D.html b/docs/api/en/core/Object3D.html index 399f53964bf3bd..eb3d8503abab09 100644 --- a/docs/api/en/core/Object3D.html +++ b/docs/api/en/core/Object3D.html @@ -206,6 +206,7 @@

[property:Object userData]

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 `{}`.

[property:String uuid]

diff --git a/docs/api/en/materials/Material.html b/docs/api/en/materials/Material.html index 9c045b98ab8656..d84429199c852b 100644 --- a/docs/api/en/materials/Material.html +++ b/docs/api/en/materials/Material.html @@ -369,6 +369,7 @@

[property:Object userData]

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 `{}`.

Methods

diff --git a/docs/api/en/textures/Texture.html b/docs/api/en/textures/Texture.html index 1b0971a6bef6d1..f607111122ff10 100644 --- a/docs/api/en/textures/Texture.html +++ b/docs/api/en/textures/Texture.html @@ -281,6 +281,7 @@

[property:Object userData]

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 `{}`.

[property:Source source]