TruWorlds

Camera

Inherits: Instance

Camera is an instance that represents a camera in the game world.

Properties

CMatrix CMatrix

The camera's coordinate matrix. Only editable when CameraMode is Scriptable.

CameraMode CameraMode

The CameraMode of the camera.

CameraOffset Vector3

The offset applied to the camera follow target, in studs.

FlySpeed float

The speed at which the camera moves when in Fly mode.

FollowDistance float

The distance the camera attempts to maintain from its follow target when in applicable modes.

FollowOffset Vector3

The offset applied to the camera follow target, in studs.

FollowTarget DynamicInstance?

The target Instance that the camera follows in applicable modes.

Fov float

The field of view (FOV) of the camera in degrees.

MaxFollowDistance float

The maximum distance the camera can be from its follow target.

MinFollowDistance float

The minimum distance the camera can be from its follow target.

OrbitFirstPersonAllowed bool

Whether first-person controls are allowed when the camera is in Orbit mode and fully zoomed in.

Position Vector3

The position of the camera.

Rotation Quaternion

The rotation of the camera.

Functions

GetMousePosition() Returns Vector2
GetViewportSize() Returns Vector2
ZoomToFitBounds(bounds: BoundsBox)

Adjusts the camera's position to fit the given bounds within the viewport, taking into consideration the viewport aspect ratio and the camera's FOV.

bounds
The bounds to fit within the camera's view.
padding
Optional padding to apply around the bounds, in studs. Default is 0, meaning the bounds will fit exactly within the view.