unreal.BlueprintCameraDirectorEvaluator

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

Bases: Object

Base class for a Blueprint camera director evaluator.

C++ Source:

  • Plugin: GameplayCameras

  • Module: GameplayCameras

  • File: BlueprintCameraDirector.h

activate_camera_director(evaluation_context_owner, params) → None

Activate Camera Director

Parameters:
activate_camera_rig(camera_rig, force_new_instance=False) → None

Specifies a camera rig to be active this frame.

Parameters:
activate_camera_rig_prefab(camera_rig: CameraRigAsset, force_new_instance: bool = False) → None

deprecated: ‘activate_camera_rig_prefab’ was renamed to ‘activate_camera_rig’.

activate_camera_rig_via_proxy(camera_rig_proxy, force_new_instance=False) → None

Specifies a camera rig to be active this frame, via a proxy which is later resolved via the proxy table of the Blueprint camera director.

Parameters:
activate_persistent_base_camera_rig(camera_rig_prefab) → None

Activates the given camera rig prefab in the base layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

activate_persistent_global_camera_rig(camera_rig_prefab) → None

Activates the given camera rig prefab in the global layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

activate_persistent_visual_camera_rig(camera_rig_prefab) → None

Activates the given camera rig prefab in the visual layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

add_child_evaluation_context(child_evaluation_context_owner) → Name

Add Child Evaluation Context

Parameters:

child_evaluation_context_owner (Object)

Return type:

Name

deactivate_camera_director(evaluation_context_owner, params) → None

Deactivate Camera Director

Parameters:
deactivate_persistent_base_camera_rig(camera_rig_prefab) → None

Deactivates the given camera rig prefab in the base layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

deactivate_persistent_global_camera_rig(camera_rig_prefab) → None

Deactivates the given camera rig prefab in the global layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

deactivate_persistent_visual_camera_rig(camera_rig_prefab) → None

Deactivates the given camera rig prefab in the visual layer.

Parameters:

camera_rig_prefab (CameraRigAsset)

find_evaluation_context_owner_actor(actor_class) → 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_conditional_context_result(condition) → BlueprintCameraEvaluationDataRef

Gets the evaluation context data for a sub-set of camera rigs.

Parameters:

condition (CameraEvaluationDataCondition)

Return type:

BlueprintCameraEvaluationDataRef

get_initial_context_result() → BlueprintCameraEvaluationDataRef

Gets the shared evaluation context data.

Return type:

BlueprintCameraEvaluationDataRef

remove_child_evaluation_context(child_evaluation_context_owner, child_slot_name) → bool

Remove Child Evaluation Context

Parameters:

  • child_evaluation_context_owner (Object)

  • child_slot_name (Name)

Return type:

bool

resolve_camera_rig_proxy(camera_rig_proxy) → CameraRigAsset

Resolves the camera rig proxy using the camera director’s proxy table.

Parameters:

camera_rig_proxy (CameraRigProxyAsset)

Return type:

CameraRigAsset

run_camera_director(delta_time, evaluation_context_owner, params) → None

Run Camera Director

Parameters:
run_child_camera_director(delta_time, child_slot_name) → bool

Run Child Camera Director

Parameters:
Return type:

bool