Skip to content

Components

CameraRig

Several named framings on a camera and the blends between them, for a room's establishing shot, a boss arena that pulls back, or a cutscene that takes over.

On this page

Add it

+ Add node → Camera Rig creates a node with it already on. Already have a node for it? Add component → CameraRigComponent.

From a script

A script on the same node writes these fields by name. CameraRigComponent is the name to pass.

rgs
set_flag("CameraRigComponent", "enabled", true);

Fields

FieldScript nameKindDefaultWhat it does
EnabledenabledcheckboxonWhether the rig drives the camera.
FramingsframingslistemptyThe shots, in no particular order. Priority decides, not position.
FieldScript nameKindDefaultWhat it does
NamenametextnoneWhat to call it. Duplicate names are an authoring slip, not an error.
SubjectsubjectnodenoneWhat this shot follows; empty holds a fixed point.
ActiveactivecheckboxnoneWhether this shot is in the running.
PriorityprioritynumbernoneWho wins. Higher takes the camera.
Zoomzoomnumber, 0.01 to 64, step 0.01noneMagnification for this shot, matching the camera's Zoom.
Rotationrotationnumber, step 1noneDutch angle; zero is level.
Blend
Durationblendnumber, at least 0, step 0.05noneSeconds to get into this shot from whatever was live.
Easeeaseone of Cut, Linear, EaseInOut, OvershootnoneThe shape the transition into this shot follows.
Framing
Dead Zonedead_zonetwo numbers (x, y), at least 0noneHow far the subject may move from where it is supposed to sit (the camera's centre plus the Offset), per axis, before the camera follows, in world units. The box tests the subject's point plus the look-ahead lead, which is not drawn.
Soft Zonesoft_zonetwo numbers (x, y), at least 0noneZero means no limit, so only the Damping setting decides how far the camera lags.
Offsetoffsettwo numbers (x, y)noneWhere in the frame the subject sits, relative to the camera's centre.
Dampingdampingtwo numbers (x, y), at least 0noneSeconds to close ninety percent of the gap, per axis.
Look-ahead
Timelookaheadnumber, at least 0, step 0.05noneSeconds of the subject's motion to lead by. Zero is no lead.
Smoothinglookahead_smoothingnumber, at least 0, step 0.05noneSeconds over which the lead itself is damped.
Limitlookahead_limitnumber, at least 0noneLargest lead in world units. Zero is uncapped.

Buttons

  • Cut to live framing