From cf4ad582f11027c918f880f81b4b4ce6e3a4cd81 Mon Sep 17 00:00:00 2001 From: artem pecheny Date: Mon, 30 Jul 2012 13:58:00 +0600 Subject: [PATCH] ASDoc for excludeLight --- src/alternativa/engine3d/core/Object3D.as | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/alternativa/engine3d/core/Object3D.as b/src/alternativa/engine3d/core/Object3D.as index b0c5630..415ac9c 100644 --- a/src/alternativa/engine3d/core/Object3D.as +++ b/src/alternativa/engine3d/core/Object3D.as @@ -1653,7 +1653,12 @@ package alternativa.engine3d.core { /** - * Toggle off light source from litting this object + * Disables lighting of the object by given light. + * + * @param light Light which should not affect to the object + * @param updateChildren If true all children of this object will be also shielded from the given light. + * @see #excludedLights() + * @see #clearExcludedLights() */ public function excludeLight(light:Light3D, updateChildren:Boolean = false):void{ if (_excludedLights.indexOf(light) < 0) { @@ -1674,7 +1679,7 @@ package alternativa.engine3d.core { } /** - * Resets list of lights excluded from litting this object + * Resets list of lights excluded from lighting this object. */ public function clearExcludedLights(updateChildren:Boolean = false):void { _excludedLights.length = 0; @@ -1686,7 +1691,7 @@ package alternativa.engine3d.core { } /** - * Returns a copy of object + * Returns a copy of object. * @return A copy of this Object3D. */ public function clone():Object3D {