# Documentation for *cameraRTS*

## cameraRTS.Activate

Activates the RTS camera.<br>

void **cameraRTS.Activate**(int view)
int view
: set 1 for the first view. Set 0 to deactivate all the views.


## cameraRTS.GetCameraRotation

Return the camera position and look-at if rotated on specified degrees<br>

point point **cameraRTS.GetCameraRotation**(int yaw)
int yaw
: degrees

_returns_ point pos, point look_at
: position and look-at position of the camera.


## cameraRTS.GetEye

Returns the camera position. (same as camera.GetPos([int view]) )<br>
This position is futher modified by the zoom. To get the real camera pos use cameraRTS.GetFramePosLookAt().<br>

point **cameraRTS.GetEye**([int view])
int view
: optional, set 1 for the first view.

_returns_ point
: camera position or InvalidPos() on error


## cameraRTS.GetFramePosLookAt

Return the exact camera position and look-at (position returned by camera.GetPos() is futher modified by the zoom)<br>

point point **cameraRTS.GetFramePosLookAt**()
_returns_ point pos, point look_at
: position and look-at position of the camera.


## cameraRTS.GetHeight

Returns the camera current height above the 'look at' position.<br>

int **cameraRTS.GetHeight**()

## cameraRTS.GetHeightInterval

Returns the camera minimal and maximal height above the ground.<br>

int int **cameraRTS.GetHeightInterval**()
_returns_ int min, int max
: minimal and maximal height


## cameraRTS.GetLookAt

Returns the camera look-at position<br>

point **cameraRTS.GetLookAt**()
_returns_ point
: camera look-at position


## cameraRTS.GetLookatDist

Returns the camera current look at ditance.<br>

int **cameraRTS.GetLookatDist**()

## cameraRTS.GetPos

Returns the camera position. (same as camera.GetEye([int view]) )<br>
This position is futher modified by the zoom. To get the real camera pos use cameraRTS.GetFramePosLookAt().<br>

point **cameraRTS.GetPos**([int view])
int view
: optional, set 1 for the first view.

_returns_ point
: camera position or InvalidPos() on error


## cameraRTS.GetPosLookAt

Returns camera position and 'look at' position of the camera.<br>
This position is futher modified by the zoom. To get the real camera pos use cameraRTS.GetFramePosLookAt().<br>

void **cameraRTS.GetPosLookAt**([int view])
int view
: optional, set 1 for the first view

_returns_ point pos, point look_at
: camera position and 'look at' point


## cameraRTS.GetProperties

Returns the camera properties in a table<br>

table **cameraRTS.GetProperties**(int view)
int view
: set 1 for the first view


## cameraRTS.GetRotateCenter

Returns the current rotation center point.<br>

point **cameraRTS.GetRotateCenter**()
_returns_ point
: camera look-at position


## cameraRTS.GetRotationRadius

Returns the low and high rotation radii<br>

point point **cameraRTS.GetRotationRadius**()
_returns_ point low, point high
: low and high rotation radii


## cameraRTS.GetYaw

Returns the camera yaw in degrees<br>

int **cameraRTS.GetYaw**()

## cameraRTS.GetYawRestore

Get the current YawRestore mode of the camera<br>

bool **cameraRTS.GetYawRestore**()

## cameraRTS.GetZoom

Changes the current zoom<br>

int **cameraRTS.GetZoom**()
_returns_ int zoom
: zoom multiplied by 1000


## cameraRTS.GetZoomLimits

Returns the current zoom limits<br>

int int **cameraRTS.GetZoomLimits**()
_returns_ int min, int max
: minimal an maximal zoom multiplied by 1000


## cameraRTS.IsActive

Check if the RTS person camera is active.<br>

bool **cameraRTS.IsActive**()

## cameraRTS.IsMoving

Return if the camera is moving<br>

bool **cameraRTS.IsMoving**()

## cameraRTS.Rotate

Rotate camera on specified degrees<br>

void **cameraRTS.Rotate**(int yaw, int time)
int yaw
: degrees

int time
: time (ms) to interpolate to the new camera


## cameraRTS.SetCamera

Set camera position and 'look at' point<br>

void **cameraRTS.SetCamera**(point pos, point look_at, [int time], [int easing])
point pos
: new position of the camera.

point look_at
: new look at position of the camera.

int time
: time (ms) to interpolate to the new camera

int easing
: interpolation parameter:

0 = "Linear",<br>
1 = "CubicIn",<br>
2 = "CubicOut",<br>
3 = "CubicInOut",<br>
4 = "QuinticIn",<br>
5 = "QuinticOut",<br>
6 = "QuinticInOut"<br>
7 = "SinIn",<br>
8 = "SinOut",<br>
9 = "SinInOut",<br>

## cameraRTS.SetCameraPrecise

Set camera position and 'look at' point<br>

void **cameraRTS.SetCameraPrecise**(point pos, point look_at, [int time])
point pos
: new position of the camera multiplied by 1000.

point look_at
: new look at position of the camera multiplied by 1000.

int time
: time (ms) to interpolate to the new camera


## cameraRTS.SetProperties

Sets camera properties from a given table<br>

void **cameraRTS.SetProperties**(int view, table properties)
int view
: set 1 for the first view

table prop
: may contain the following fields:

MinHeight, MaxHeight - sets the min and max height of the camera.<br>
HeightInertia - the larger the number, the faster the camera height comes to rest when changed.<br>
MoveSpeedNormal, MoveSpeedFast - normal and fast camera movement speed; fast is used when Ctrl is pressed.<br>
RotateSpeed - the camera rotation speed.<br>
LookatDist - 2D distance from the camera position to the 'look at' point.<br>
LowRotationRadius, HighRotationRadius - radii of camera rotation when the camera is at the lowest and the highest position.<br>
CameraYawRestore - 0 to toogle yaw restore off, 1 to toggle it on.<br>
UpDownSpeed - the speed the camera moves vertically.<br>

## cameraRTS.SetYawRestore

Set the YawRestore mode of the camera. (the camera yaw is restored to 0)<br>

void **cameraRTS.SetYawRestore**(bool restore)
bool restore
: enable or disable that mode


## cameraRTS.SetZoom

Returns the current zoom<br>

void **cameraRTS.SetZoom**(int zoom, [int time])
int zoom
: zoom multiplied by 1000

int time
: time (ms) to interpolate to the new zoom


## cameraRTS.SetZoomLimits

Changes the zoom limits<br>

void **cameraRTS.SetZoomLimits**(int min, int max)
int min
: minimal zoom multiplied by 1000

int max
: maximal zoom multiplied by 1000





(insert footer.md.html here)
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style>
<script src="markdeep.min.js"></script>
<script src="https://casual-effects.com/markdeep/latest/markdeep.min.js"></script>
<script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>