Browse Source

Update english documentation about the Object3D updateMatrixWorld and its force parameter (#24725) (#24726)

Adam N 2 years ago
parent
commit
da8983cb7e
1 changed files with 7 additions and 1 deletions
  1. 7 1
      docs/api/en/core/Object3D.html

+ 7 - 1
docs/api/en/core/Object3D.html

@@ -470,7 +470,13 @@
 		<p>Updates the local transform.</p>
 		<p>Updates the local transform.</p>
 
 
 		<h3>[method:undefined updateMatrixWorld]( [param:Boolean force] )</h3>
 		<h3>[method:undefined updateMatrixWorld]( [param:Boolean force] )</h3>
-		<p>Updates the global transform of the object and its descendants.</p>
+		<p>
+		force - A boolean that can be used to bypass [page:.matrixWorldAutoUpdate],
+		to recalculate the world matrix of the object and descendants on the current frame.
+		Useful if you cannot wait for the renderer to update it on the next frame (assuming [page:.matrixWorldAutoUpdate] set to true).<br /><br />
+
+		Updates the global transform of the object and its descendants if the world matrix needs update ([page:.matrixWorldNeedsUpdate] set to true) or if the force boolean parameter is set to true.
+		</p>
 
 
 		<h3>[method:undefined updateWorldMatrix]( [param:Boolean updateParents], [param:Boolean updateChildren] )</h3>
 		<h3>[method:undefined updateWorldMatrix]( [param:Boolean updateParents], [param:Boolean updateChildren] )</h3>
 		<p>
 		<p>