Changes: API CameraZoomIn

Revision as of 09:28, 20 January 2007

CameraZoomIn

Zooms the camera into the viewplane

CameraZoomIn(increment)

Parameters

Arguments

(float increment)

Returns

nil

Details

Zooms the camera into the viewplane by increment. The increment must be between 0.0 and 5.0 with 0.0 indicating no zoom relative to current view and 5.0 being maximum zoom. From a completely zoomed out position, an increment of 5.0 will result in a first person camera angle.

As of patch 1.9.0 if the 'Interface Options > Advanced Options > Max Camera Distance' setting is set to Low, then the largest value for increment is 15. If this setting is set to High, then the largest value for increment is 30.

@@ Line 10: / Line 10: @@
 === Returns ===
-:<i>nil</i>
+:''nil''
 == Details ==
-: Zooms the camera into the viewplane by <i>increment</i>.  The increment must be between 0.0 and 5.0 with 0.0 indicating no zoom relative to current view and 5.0 being maximum zoom.  From a completely zoomed out position, an increment of 5.0 will result in a first person camera angle.
+: Zooms the camera into the viewplane by ''increment''.  The increment must be between 0.0 and 5.0 with 0.0 indicating no zoom relative to current view and 5.0 being maximum zoom.  From a completely zoomed out position, an increment of 5.0 will result in a first person camera angle.