Camera

Defines the position, orientation, and rendering settings used to view the world.

Properties

Property	Type	Default
`FieldOfView`	`number`	`70`
`CFrame`	`any`	`DEFAULT_CFRAME`
`Position`	`any`	`DEFAULT_CFRAME.Position`
`Roll`	`number`	`0`
`Name`	`string`	`"Camera"`
`CameraType`	`EnumItem`	`Enum.CameraType.Custom`
`CameraSubject`	`any`	`nil`
`Focus`	`CFrame`	`CFrame.new(0, 0, 0)`
`MoveSpeed`	`number`	`10`
`MouseSensitivity`	`number`	`0.003`
`OrbitDistance`	`number`	`12`
`MinOrbitDistance`	`number`	`2`
`MaxOrbitDistance`	`number`	`128`
`FirstPersonOffset`	`Vector3`	`Vector3.new(0, 0, 0)`
`SubjectSmoothing`	`number`	`8`
`FollowDistance`	`number`	`12`
`FollowHeight`	`number`	`4`
`FollowLookAhead`	`number`	`0.15`
`FollowFocusOffset`	`Vector3`	`Vector3.new(0, 2, 0)`
`ShoulderOffset`	`Vector3`	`Vector3.new(3, 2, 8)`
`ShoulderFocusOffset`	`Vector3`	`Vector3.new(0, 2, 0)`
`TopDownHeight`	`number`	`32`
`IsometricOffset`	`Vector3`	`Vector3.new(1, 1, 1)`

Functions

`getModeName`

Arguments

cameraType

Returns

This function returns nothing.

`getCFramePosition`

Arguments

value

Returns

This function returns nothing.

`getSubjectCFrame`

Arguments

subject

Returns

This function returns nothing.

`getSubjectPosition`

Arguments

subject

Returns

This function returns nothing.

`getSubjectVelocity`

Arguments

subject

Returns

This function returns nothing.

`clampDistance`

Arguments

instance, distance

Returns

This function returns nothing.

`getSmoothingAlpha`

Arguments

instance, delta

Returns

This function returns nothing.

`readRotation`

Arguments

cframe

Returns

This function returns nothing.

`readOrbit`

Arguments

cframe, subjectPosition, fallbackDistance

Returns

This function returns nothing.

`setCursorCaptured`

Arguments

state, window, captured

Returns

This function returns nothing.

`updateLookInput`

Arguments

instance, state, window, alwaysCaptured

Returns

This function returns nothing.

`writeCamera`

Arguments

instance, state, cframe, focusPosition

Returns

This function returns nothing.

`smoothSubjectCamera`

Arguments

instance, state, desiredPosition, desiredFocus, delta, up

Returns

This function returns nothing.

`updateDistanceProperty`

Arguments

instance, state, propertyName

Returns

This function returns nothing.

`initializeMode`

Arguments

instance, state, mode, subjectPosition

Returns

This function returns nothing.

`updateCustom`

Arguments

instance, state, delta, window

Returns

This function returns nothing.

`updateOrbit`

Arguments

instance, state, subjectPosition, window

Returns

This function returns nothing.

`updateFirstPerson`

Arguments

instance, state, subjectPosition, window

Returns

This function returns nothing.

`updateWatch`

Arguments

instance, state, subjectPosition, window

Returns

This function returns nothing.

`updateFollow`

Arguments

instance, state, subject, subjectCFrame, delta, window

Returns

This function returns nothing.

`updateShoulder`

Arguments

instance, state, subjectCFrame, delta, window

Returns

This function returns nothing.

`updateTopDown`

Arguments

instance, state, subjectCFrame, delta, window

Returns

This function returns nothing.

`updateIsometric`

Arguments

instance, state, subjectPosition, delta, window

Returns

This function returns nothing.

API

instance:getModeName(cameraType)
instance:getCFramePosition(value)
instance:getSubjectCFrame(subject)
instance:getSubjectPosition(subject)
instance:getSubjectVelocity(subject)
instance:clampDistance(instance, distance)
instance:getSmoothingAlpha(instance, delta)
instance:readRotation(cframe)
instance:readOrbit(cframe, subjectPosition, fallbackDistance)
instance:setCursorCaptured(state, window, captured)
instance:updateLookInput(instance, state, window, alwaysCaptured)
instance:writeCamera(instance, state, cframe, focusPosition)
instance:smoothSubjectCamera(instance, state, desiredPosition, desiredFocus, delta, up)
instance:updateDistanceProperty(instance, state, propertyName)
instance:initializeMode(instance, state, mode, subjectPosition)
instance:updateCustom(instance, state, delta, window)
instance:updateOrbit(instance, state, subjectPosition, window)
instance:updateFirstPerson(instance, state, subjectPosition, window)
instance:updateWatch(instance, state, subjectPosition, window)
instance:updateFollow(instance, state, subject, subjectCFrame, delta, window)
instance:updateShoulder(instance, state, subjectCFrame, delta, window)
instance:updateTopDown(instance, state, subjectCFrame, delta, window)
instance:updateIsometric(instance, state, subjectPosition, delta, window)

BrickColorValue

Has a Value property which is a Brick Color value, and is Customizable.

Camera2D

A camera dedicated to 2D world rendering.