Browse Source

Merge pull request #20386 from mjurczyk/object3d-traverse-docs-update

Object3D: Add note about traversal in docs
Mr.doob 4 years ago
parent
commit
9ea590ae4f
1 changed files with 3 additions and 3 deletions
  1. 3 3
      docs/api/en/core/Object3D.html

+ 3 - 3
docs/api/en/core/Object3D.html

@@ -413,7 +413,7 @@
 		<p>
 		<p>
 		callback - A function with as first argument an object3D object.<br /><br />
 		callback - A function with as first argument an object3D object.<br /><br />
 
 
-		Executes the callback on this object and all descendants.
+		Executes the callback on this object and all descendants. <strong>Warning:</strong> Do not add, move, or remove the object or its descendants while traversing.
 		</p>
 		</p>
 
 
 		<h3>[method:null traverseVisible]( [param:Function callback] )</h3>
 		<h3>[method:null traverseVisible]( [param:Function callback] )</h3>
@@ -421,14 +421,14 @@
 		callback - A function with as first argument an object3D object.<br /><br />
 		callback - A function with as first argument an object3D object.<br /><br />
 
 
 		Like traverse, but the callback will only be executed for visible objects.
 		Like traverse, but the callback will only be executed for visible objects.
-		Descendants of invisible objects are not traversed.
+		Descendants of invisible objects are not traversed. <strong>Warning:</strong> Do not add, move, or remove the object or its descendants while traversing.
 		</p>
 		</p>
 
 
 		<h3>[method:null traverseAncestors]( [param:Function callback] )</h3>
 		<h3>[method:null traverseAncestors]( [param:Function callback] )</h3>
 		<p>
 		<p>
 		callback - A function with as first argument an object3D object.<br /><br />
 		callback - A function with as first argument an object3D object.<br /><br />
 
 
-		Executes the callback on all ancestors.
+		Executes the callback on all ancestors.  <strong>Warning:</strong> Do not add, move, or remove the object or its ancestors while traversing.
 		</p>
 		</p>
 
 
 		<h3>[method:null updateMatrix]()</h3>
 		<h3>[method:null updateMatrix]()</h3>