Kit camera

25 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia

Use camera.* to inspect and configure cine-camera work, build physical rail/crane moves, and read the active PIE view. Generic actor creation and transforms remain in actor.*; sequence camera cuts remain in sequencer.*.

Start with a camera actor created through camera.spawn_camera (kind="cine" or kind="camera"; add mountRig="rail" or "crane" to spawn a rig at the same place with the camera already mounted on it), or actor.spawn_camera. Then inspect it with camera.get, use camera.configure_component when a placed camera needs explicit controller-rotation or HMD locks, read cine settings with camera.get_cine, and call camera.list_cine_presets before choosing project-defined preset names. Use camera.configure_cine to apply focal length, aperture, a filmback or lens preset, and manual focus distance in one transaction. camera.configure_tracking_focus changes the cine camera to tracking focus, with an optional target actor and a centimetre offset; it can draw a transient marker for framing review.

For a physical move, call camera.spawn_rig with kind="rail" or kind="crane". Set a rail's normalized position from 0 to 1, or a crane's pitch/yaw and arm length in centimetres. camera.attach_to_rig uses the rig's public moving mount, so subsequent rail/crane controls move the camera. Preserve world placement with its default keepWorldTransform=true unless you deliberately want the camera aligned to the mount.

During Play-In-Editor, call camera.get_runtime_view to inspect the active controller's target, point of view and FOV. Use the existing play.set_view_target if the runtime camera must change. Use sequencer.add_track with kind="camera_cut" when authoring cuts in a Level Sequence.

Typical sequence:

1. camera.spawn_camera with kind="cine", a label and initial transform (optionally mountRig).
2. camera.get_cine to establish the current optical state.
3. camera.list_cine_presets, then camera.configure_cine with the required lens/filmback and manual focus distance.
4. camera.spawn_rig for a rail or crane at the desired set location.
5. camera.get_rig to inspect the rig mount and camera.attach_to_rig using the camera and rig labels.
6. camera.configure_rail or camera.configure_crane to compose the move.
7. Create the Level Sequence with sequencer.create and add a camera_cut track through sequencer.add_track.
8. Start PIE and use camera.get_runtime_view to confirm the active in-game POV.

Names are resolved as labels, object names or paths. Camera focus distance and rig dimensions are centimetres; lens focal length and filmback are millimetres. Editor viewport navigation is owned by view.get_camera and view.set_camera. The kit does not create a second runtime view-target setter, because play.set_view_target is already the stable player-controller workflow.

Use camera.list_rigs to audit rail and crane placement before changing a move. It reports only native rail/crane actors, including their mounted cameras.

PIE controls: camera.add_camera_modifier, camera.remove_camera_modifier, camera.start_camera_shake, camera.stop_all_camera_shakes, camera.set_game_camera_cut_this_frame, and camera.set_view_target_with_blend act on a selected PIE player controller. They never start PIE.

Rail splines: camera.list_spline_points, camera.add_spline_point, camera.set_spline_point and camera.remove_spline_point edit the rail path (local space unless worldSpace=true); remove accepts index=-1 for the last point and refuses to leave fewer than two points.

camera.start_camera_shake needs a concrete shake class. The engine oscillation shake is MatineeCameraShake on 4.27 and LegacyCameraShake on 5.x; either name is accepted on both. Abstract classes (CameraShakeBase) are rejected. camera.set_view_target_with_blend resolves the target by label, name or unique class name (DefaultPawn for the default pawn).

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

camera.add_camera_modifier (risco 2, altera, requer PIE, smoke)

Adds a camera modifier of a concrete UCameraModifier class to the PIE player's camera manager.

Argumento	Tipo	Descrição
class	string	obrigatório. Modifier or shake class (path or short name).

camera.add_spline_point (risco 2, altera, requer mundo, smoke)

Sem descrição.

Argumento	Tipo	Descrição
rig	string	obrigatório. Rail rig actor.
index	integer	Point index for set/remove; remove accepts -1 for the last point. Padrão -1.
location	{x,y,z}	Point position in centimetres.
worldSpace	boolean	Use world coordinates; false uses spline local coordinates. Padrão false.

camera.attach_to_rig (risco 2, altera, requer mundo, smoke)

Attaches a camera actor to the public moving mount of a rail or crane.

Argumento	Tipo	Descrição
camera	string	obrigatório. Camera actor label, object name or path.
rig	string	obrigatório. Camera rail or crane label, object name or path.
keepWorldTransform	boolean	Preserve the camera world transform during attachment. Padrão true.

camera.configure_cine (risco 2, altera, requer mundo, smoke)

Changes focal length, aperture, named presets and manual/disabled focus without changing the actor transform.

Argumento	Tipo	Descrição
actor	string	obrigatório. Cine camera actor label, object name or path.
focalLength	number	Focal length in millimetres; zero preserves it. Padrão 0.0.
aperture	number	Aperture in f-stops; zero preserves it. Padrão 0.0.
filmbackPreset	string	Filmback preset name; empty preserves the current filmback.
lensPreset	string	Lens preset name; empty preserves the current lens settings.
focusMethod	string	Focus method: manual or disable; empty preserves it.
manualFocusDistance	number	Manual focus distance in centimetres; zero preserves it. Padrão 0.0.

camera.configure_component (risco 2, altera, requer mundo, smoke)

Sets controller-rotation and HMD locks on a placed camera component.

Argumento	Tipo	Descrição
actor	string	obrigatório. Camera actor label, object name or path.
hasUsePawnControlRotation	boolean	Apply usePawnControlRotation when true. Padrão false.
usePawnControlRotation	boolean	Let a pawn controller drive the camera rotation. Padrão false.
hasLockToHmd	boolean	Apply lockToHmd when true. Padrão false.
lockToHmd	boolean	Lock camera position and rotation to the active HMD. Padrão false.

camera.configure_crane (risco 2, altera, requer mundo, smoke)

Sets a crane rig's arm length, yaw, pitch and mount locks.

Argumento	Tipo	Descrição
rig	string	obrigatório. Crane rig actor label, object name or path.
pitch	number	Crane arm pitch in degrees. Padrão 0.0.
yaw	number	Crane arm yaw in degrees. Padrão 0.0.
armLength	number	Crane arm length in centimetres; zero preserves it. Padrão 0.0.
lockMountPitch	boolean	Whether the camera mount follows crane pitch. Padrão true.
lockMountYaw	boolean	Whether the camera mount follows crane yaw. Padrão true.

camera.configure_rail (risco 2, altera, requer mundo, smoke)

Sets a rail rig's normalized position and mount orientation lock.

Argumento	Tipo	Descrição
rig	string	obrigatório. Rail rig actor label, object name or path.
position	number	Normalized rail position from 0 through 1. Padrão 0.0.
lockOrientation	boolean	Whether the camera mount follows the rail tangent. Padrão true.

camera.configure_tracking_focus (risco 2, altera, requer mundo, smoke)

Configures tracking focus against an optional actor with a relative-centimetre offset.

Argumento	Tipo	Descrição
actor	string	obrigatório. Cine camera actor label, object name or path.
targetActor	string	Optional actor to track; an empty value clears the current tracking target.
relativeOffset	{x,y,z}	Offset from target origin in centimetres.
drawDebugMarker	boolean	Draw a transient editor-world marker at the target offset. Padrão false.

camera.get (risco 0, requer mundo, smoke)

Gets transform, projection and cine settings from one camera actor.

Argumento	Tipo	Descrição
actor	string	obrigatório. Camera actor label, object name or path.

camera.get_cine (risco 0, requer mundo, smoke)

Gets cine-specific lens, filmback and focus state.

Argumento	Tipo	Descrição
actor	string	obrigatório. Cine camera actor label, object name or path.

camera.get_rig (risco 0, requer mundo, smoke)

Gets one rail or crane actor's current mechanical state and mounted cameras.

Argumento	Tipo	Descrição
actor	string	obrigatório. Camera actor label, object name or path.

camera.get_runtime_view (risco 0, requer PIE, smoke)

Gets the active player-controller view target and point of view during PIE.

Argumento	Tipo	Descrição
playerIndex	integer	Zero-based local player controller index. Padrão 0.

camera.list (risco 0, requer mundo, smoke)

Lists camera and cine-camera actors in the editor world.

Argumento	Tipo	Descrição
nameContains	string	Optional case-insensitive label or object-name fragment.
limit	integer	Maximum cameras to return. Padrão 100.

camera.list_cine_presets (risco 0, requer mundo, smoke)

Lists the project cine-camera filmback and lens preset names.

Argumento	Tipo	Descrição
actor	string	obrigatório. Cine camera actor label, object name or path.

camera.list_rigs (risco 0, requer mundo, smoke)

Lists editor-world rail and crane actors with their current mechanical state.

Argumento	Tipo	Descrição
nameContains	string	Optional case-insensitive rail or crane label/name fragment.
limit	integer	Maximum rigs to return. Padrão 100.

camera.list_spline_points (risco 0, requer mundo, smoke)

Sem descrição.

Argumento	Tipo	Descrição
rig	string	obrigatório. Rail rig actor.
index	integer	Point index for set/remove; remove accepts -1 for the last point. Padrão -1.
location	{x,y,z}	Point position in centimetres.
worldSpace	boolean	Use world coordinates; false uses spline local coordinates. Padrão false.

camera.remove_camera_modifier (risco 2, altera, requer PIE, smoke)

Removes the first active camera modifier of the class from the PIE player's camera manager.

Argumento	Tipo	Descrição
class	string	obrigatório. Modifier or shake class (path or short name).

camera.remove_spline_point (risco 2, altera, requer mundo, smoke)

Sem descrição.

Argumento	Tipo	Descrição
rig	string	obrigatório. Rail rig actor.
index	integer	Point index for set/remove; remove accepts -1 for the last point. Padrão -1.
location	{x,y,z}	Point position in centimetres.
worldSpace	boolean	Use world coordinates; false uses spline local coordinates. Padrão false.

camera.set_game_camera_cut_this_frame (risco 2, altera, requer PIE, smoke)

Flags a camera cut for this frame (resets motion blur and temporal history).

Argumento	Tipo	Descrição
playerIndex	integer	Zero-based local player controller index. Padrão 0.

camera.set_spline_point (risco 2, altera, requer mundo, smoke)

Sem descrição.

Argumento	Tipo	Descrição
rig	string	obrigatório. Rail rig actor.
index	integer	Point index for set/remove; remove accepts -1 for the last point. Padrão -1.
location	{x,y,z}	Point position in centimetres.
worldSpace	boolean	Use world coordinates; false uses spline local coordinates. Padrão false.

camera.set_view_target_with_blend (risco 2, altera, requer PIE, smoke)

Sets the PIE player's view target (actor label, name or unique class) with an optional blend in seconds.

Argumento	Tipo	Descrição
target	string	obrigatório. New camera view target actor (label, object name or unique class name).
blendTime	number	Blend duration in seconds. Padrão 0.

camera.spawn_camera (risco 2, altera, requer mundo, smoke)

Spawns a camera or cine-camera actor in the editor world, optionally mounted on a new rail or crane rig; returns the camera state (rig label in message).

Argumento	Tipo	Descrição
kind	string	Camera kind: camera (ACameraActor) or cine (ACineCameraActor). Padrão TEXT("cine").
name	string	Actor label; an engine-unique label is chosen when empty.
location	{x,y,z}	World location in centimetres.
rotation	{x,y,z}	Rotation as pitch, yaw and roll in degrees.
mountRig	string	Optional rig to spawn at the same place with the camera mounted on it: rail or crane; empty spawns no rig.
rigName	string	Label of the rig spawned by mountRig; defaults to _Rig.

camera.spawn_rig (risco 2, altera, requer mundo, smoke)

Spawns a native rail or crane rig in the editor world.

Argumento	Tipo	Descrição
kind	string	obrigatório. Rig kind: rail or crane.
name	string	Actor label; an engine-unique label is chosen when empty.
location	{x,y,z}	World location in centimetres.
rotation	{x,y,z}	Rotation as pitch, yaw and roll in degrees.

camera.start_camera_shake (risco 2, altera, requer PIE, smoke)

Starts a concrete camera shake class on the PIE player (MatineeCameraShake/LegacyCameraShake are accepted on every engine).

Argumento	Tipo	Descrição
class	string	obrigatório. Modifier or shake class (path or short name).

camera.stop_all_camera_shakes (risco 2, altera, requer PIE, smoke)

Stops every active camera shake on the PIE player.

Argumento	Tipo	Descrição
playerIndex	integer	Zero-based local player controller index. Padrão 0.