Camera

Class fields

Field	XML type	Value
`Name`	string	Camera
`ExplorerOrder`	string	5
`ExplorerImageIndex`	string	5

Properties

CFrame

CoordinateFrame

Field	XML type	Value
`Name`	string	CFrame
`summary`	string	The current position and rotation of the Camera. For most CameraTypes, the rotation is set such that the CoordinateFrame lookVector is pointing at the Focus.

CameraSubject

Object

Field	XML type	Value
`Name`	string	CameraSubject
`summary`	string	Where the Camera's focus is. Any rotation of the camera will be about this subject.

CameraType

CameraType

Field	XML type	Value
`Name`	string	CameraType
`summary`	string	Defines how the camera will behave. <a href="http://wiki.roblox.com/index.php/CameraType" target="_blank">More info</a>

CoordinateFrame

CoordinateFrame

Field	XML type	Value
`Name`	string	CoordinateFrame
`Deprecated`	bool	true
`summary`	string	The current position and rotation of the Camera. For most CameraTypes, the rotation is set such that the CoordinateFrame lookVector is pointing at the Focus.

FieldOfView

float

Field	XML type	Value
`Name`	string	FieldOfView
`summary`	string	The current angle, or width, of what the camera can see. Current acceptable values are from 20 degrees to 80.

Focus

CoordinateFrame

Field	XML type	Value
`Name`	string	Focus
`summary`	string	The current CoordinateFrame that the camera is looking at. Note: it is not always guaranteed that the camera is always looking here.

HeadLocked

bool

Field	XML type	Value
`Name`	string	HeadLocked

ViewportSize

Vector2

Field	XML type	Value
`Name`	string	ViewportSize
`summary`	string	Holds the x,y screen resolution of the viewport the camera is presenting (note: this can differ from the AbsoluteSize property of a full screen gui).

focus

CoordinateFrame

Field	XML type	Value
`Name`	string	focus

Functions

GetPanSpeed

() → float

Field	XML type	Value
`Name`	string	GetPanSpeed

GetRenderCFrame

() → CoordinateFrame

Field	XML type	Value
`Name`	string	GetRenderCFrame

GetRoll

() → float

Field	XML type	Value
`Name`	string	GetRoll
`summary`	string	Returns the camera's current roll. Roll is defined in radians, and is stored as the delta from the camera's y axis default normal vector.

GetTiltSpeed

() → float

Field	XML type	Value
`Name`	string	GetTiltSpeed

Interpolate

(endPos: CoordinateFrame, endFocus: CoordinateFrame, duration: float) → void

Field	XML type	Value
`Name`	string	Interpolate

PanUnits

(units: int) → void

Field	XML type	Value
`Name`	string	PanUnits

ScreenPointToRay

(x: float, y: float, depth: float = …) → Ray

Field	XML type	Value
`Name`	string	ScreenPointToRay
`summary`	string	Takes a 2D screen position and produces a Ray object to be used for 3D raycasting. Input is x,y screen coordinates, and a (optional, defaults to 0) z position which sets how far in the camera look vector to start the ray origin.

SetCameraPanMode

(mode: CameraPanMode = …) → void

Field	XML type	Value
`Name`	string	SetCameraPanMode

SetRoll

(rollAngle: float) → void

Field	XML type	Value
`Name`	string	SetRoll
`summary`	string	Sets the camera's current roll. Roll is defined in radians, and is stored as the delta from the camera's y axis default normal vector.

TiltUnits

(units: int) → bool

Field	XML type	Value
`Name`	string	TiltUnits

ViewportPointToRay

(x: float, y: float, depth: float = …) → Ray

Field	XML type	Value
`Name`	string	ViewportPointToRay
`summary`	string	Same as ScreenPointToRay, except no GUI offsets are taken into account. Useful for things like casting a ray from the middle of the Camera.ViewportSize

WorldToScreenPoint

(worldPoint: Vector3) → Tuple

Field	XML type	Value
`Name`	string	WorldToScreenPoint
`summary`	string	Takes a 3D position in the world and projects it onto x,y coordinates of screen space. Returns two values, first is a Vector3 that has x,y position and z position which is distance from camera (negative if behind camera, positive if in front). Second return value is a boolean indicating if the first argument is an on-screen coordinate.

WorldToViewportPoint

(worldPoint: Vector3) → Tuple

Field	XML type	Value
`Name`	string	WorldToViewportPoint
`summary`	string	Same as WorldToScreenPoint, except no GUI offsets are taken into account.

Zoom

(distance: float) → bool

Field	XML type	Value
`Name`	string	Zoom

Events

FirstPersonTransition

(entering: bool) → void

Field	XML type	Value
`Name`	string	FirstPersonTransition

InterpolationFinished

() → void

Field	XML type	Value
`Name`	string	InterpolationFinished