unreal.BlueprintCameraNodeEvaluator

class unreal.BlueprintCameraNodeEvaluator(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

The base class for Blueprint camera node evaluators.

C++ Source:

• Plugin: GameplayCameras

• Module: GameplayCameras

• File: BlueprintCameraNode.h

Editor Properties: (see get_editor_property/set_editor_property)

• camera_data (BlueprintCameraEvaluationDataRef): [Read-Write] The input/output camera data for this frame.

• camera_pose (BlueprintCameraPose): [Read-Write] Deprecated fields. deprecated: Please use CameraData, or GetCurrentCameraPose and SetCurrentCameraPose

• evaluation_context_owner (Object): [Read-Write] The owner object of this camera node’s evaluation context.

• is_active_camera_rig (bool): [Read-Write] Whether this camera node is running inside the active camera rig in this layer.

• is_first_frame (bool): [Read-Write] Whether this is the first frame of this camera node’s lifetime.

• variable_table (BlueprintCameraEvaluationDataRef): [Read-Write] deprecated: Please use CameraData

property camera_data: BlueprintCameraEvaluationDataRef

[Read-Only] The input/output camera data for this frame.

Type:

(BlueprintCameraEvaluationDataRef)

property camera_pose: BlueprintCameraPose

[Read-Write] Deprecated fields. deprecated: Please use CameraData, or GetCurrentCameraPose and SetCurrentCameraPose

Type:

(BlueprintCameraPose)

property evaluation_context_owner: Object

[Read-Only] The owner object of this camera node’s evaluation context.

Type:

(Object)

find_evaluation_context_owner_actor(actor_class=None) → Actor

A utility function that tries to find if an actor owns the evaluation context. Handles the situation where the evaluation context is an actor component (like a UGameplayCameraComponent) or an actor itself.

Parameters:

actor_class (type(Class))

Return type:

Actor

get_current_camera_pose() → BlueprintCameraPose

A utility function to get the current camera pose from this node’s camera data.

Return type:

BlueprintCameraPose

get_player_controller() → PlayerController

Gets the player controller that the node is running for, if any.

Return type:

PlayerController

initialize_camera_node() → None

Initialize Camera Node

property is_active_camera_rig: bool

[Read-Only] Whether this camera node is running inside the active camera rig in this layer.

Type:

(bool)

property is_first_frame: bool

[Read-Only] Whether this is the first frame of this camera node’s lifetime.

Type:

(bool)

set_current_camera_pose(camera_pose) → None

A utility function to set the current camera pose on this node’s camera data.

Parameters:

camera_pose (BlueprintCameraPose)

set_default_owning_camera_rig_parameters(target_camera_data) → None

Assigns the default parameter values of the owning camera rig to the given camera evaluation data.

Parameters:

target_camera_data (BlueprintCameraEvaluationDataRef)

tick_camera_node(delta_time) → None

The main execution callback for the camera node. Call SetCameraPose to affect the result.

Parameters:

delta_time (float)

property variable_table: BlueprintCameraEvaluationDataRef

[Read-Only] deprecated: Please use CameraData

Type:

(BlueprintCameraEvaluationDataRef)