Saltar al contenido principal

Kit camera

25 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.

Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en tools/list).

Guía​

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).

Herramientas​

Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de MaxAutoRisk requieren "_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumento dryRun. smoke = cubierto por edit.self_test.

camera.add_camera_modifier (riesgo 2, modifica, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
classstringobligatorio. Modifier or shake class (path or short name).

camera.add_spline_point (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
rigstringobligatorio. Rail rig actor.
indexintegerPoint index for set/remove; remove accepts -1 for the last point. Valor predeterminado -1.
location{x,y,z}Point position in centimetres.
worldSpacebooleanUse world coordinates; false uses spline local coordinates. Valor predeterminado false.

camera.attach_to_rig (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
camerastringobligatorio. Camera actor label, object name or path.
rigstringobligatorio. Camera rail or crane label, object name or path.
keepWorldTransformbooleanPreserve the camera world transform during attachment. Valor predeterminado true.

camera.configure_cine (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Cine camera actor label, object name or path.
focalLengthnumberFocal length in millimetres; zero preserves it. Valor predeterminado 0.0.
aperturenumberAperture in f-stops; zero preserves it. Valor predeterminado 0.0.
filmbackPresetstringFilmback preset name; empty preserves the current filmback.
lensPresetstringLens preset name; empty preserves the current lens settings.
focusMethodstringFocus method: manual or disable; empty preserves it.
manualFocusDistancenumberManual focus distance in centimetres; zero preserves it. Valor predeterminado 0.0.

camera.configure_component (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Camera actor label, object name or path.
hasUsePawnControlRotationbooleanApply usePawnControlRotation when true. Valor predeterminado false.
usePawnControlRotationbooleanLet a pawn controller drive the camera rotation. Valor predeterminado false.
hasLockToHmdbooleanApply lockToHmd when true. Valor predeterminado false.
lockToHmdbooleanLock camera position and rotation to the active HMD. Valor predeterminado false.

camera.configure_crane (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
rigstringobligatorio. Crane rig actor label, object name or path.
pitchnumberCrane arm pitch in degrees. Valor predeterminado 0.0.
yawnumberCrane arm yaw in degrees. Valor predeterminado 0.0.
armLengthnumberCrane arm length in centimetres; zero preserves it. Valor predeterminado 0.0.
lockMountPitchbooleanWhether the camera mount follows crane pitch. Valor predeterminado true.
lockMountYawbooleanWhether the camera mount follows crane yaw. Valor predeterminado true.

camera.configure_rail (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
rigstringobligatorio. Rail rig actor label, object name or path.
positionnumberNormalized rail position from 0 through 1. Valor predeterminado 0.0.
lockOrientationbooleanWhether the camera mount follows the rail tangent. Valor predeterminado true.

camera.configure_tracking_focus (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Cine camera actor label, object name or path.
targetActorstringOptional actor to track; an empty value clears the current tracking target.
relativeOffset{x,y,z}Offset from target origin in centimetres.
drawDebugMarkerbooleanDraw a transient editor-world marker at the target offset. Valor predeterminado false.

camera.get (riesgo 0, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Camera actor label, object name or path.

camera.get_cine (riesgo 0, requiere mundo, smoke)​

Gets cine-specific lens, filmback and focus state.

ArgumentoTipoDescripción
actorstringobligatorio. Cine camera actor label, object name or path.

camera.get_rig (riesgo 0, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Camera actor label, object name or path.

camera.get_runtime_view (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerZero-based local player controller index. Valor predeterminado 0.

camera.list (riesgo 0, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
nameContainsstringOptional case-insensitive label or object-name fragment.
limitintegerMaximum cameras to return. Valor predeterminado 100.

camera.list_cine_presets (riesgo 0, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
actorstringobligatorio. Cine camera actor label, object name or path.

camera.list_rigs (riesgo 0, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
nameContainsstringOptional case-insensitive rail or crane label/name fragment.
limitintegerMaximum rigs to return. Valor predeterminado 100.

camera.list_spline_points (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
rigstringobligatorio. Rail rig actor.
indexintegerPoint index for set/remove; remove accepts -1 for the last point. Valor predeterminado -1.
location{x,y,z}Point position in centimetres.
worldSpacebooleanUse world coordinates; false uses spline local coordinates. Valor predeterminado false.

camera.remove_camera_modifier (riesgo 2, modifica, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
classstringobligatorio. Modifier or shake class (path or short name).

camera.remove_spline_point (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
rigstringobligatorio. Rail rig actor.
indexintegerPoint index for set/remove; remove accepts -1 for the last point. Valor predeterminado -1.
location{x,y,z}Point position in centimetres.
worldSpacebooleanUse world coordinates; false uses spline local coordinates. Valor predeterminado false.

camera.set_game_camera_cut_this_frame (riesgo 2, modifica, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerZero-based local player controller index. Valor predeterminado 0.

camera.set_spline_point (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
rigstringobligatorio. Rail rig actor.
indexintegerPoint index for set/remove; remove accepts -1 for the last point. Valor predeterminado -1.
location{x,y,z}Point position in centimetres.
worldSpacebooleanUse world coordinates; false uses spline local coordinates. Valor predeterminado false.

camera.set_view_target_with_blend (riesgo 2, modifica, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio. New camera view target actor (label, object name or unique class name).
blendTimenumberBlend duration in seconds. Valor predeterminado 0.

camera.spawn_camera (riesgo 2, modifica, requiere 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).

ArgumentoTipoDescripción
kindstringCamera kind: camera (ACameraActor) or cine (ACineCameraActor). Valor predeterminado TEXT("cine").
namestringActor 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.
mountRigstringOptional rig to spawn at the same place with the camera mounted on it: rail or crane; empty spawns no rig.
rigNamestringLabel of the rig spawned by mountRig; defaults to _Rig.

camera.spawn_rig (riesgo 2, modifica, requiere mundo, smoke)​

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

ArgumentoTipoDescripción
kindstringobligatorio. Rig kind: rail or crane.
namestringActor 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 (riesgo 2, modifica, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
classstringobligatorio. Modifier or shake class (path or short name).

camera.stop_all_camera_shakes (riesgo 2, modifica, requiere PIE, smoke)​

Stops every active camera shake on the PIE player.

ArgumentoTipoDescripción
playerIndexintegerZero-based local player controller index. Valor predeterminado 0.