unreal.CameraAnimationCameraModifier

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

Bases: CameraModifier

A camera modifier that plays camera animation sequences.

C++ Source:

  • Plugin: GameplayCameras

  • Module: GameplayCameras

  • File: CameraAnimationCameraModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alpha (float): [Read-Write] Current blend alpha.

  • alpha_in_time (float): [Read-Write] When blending in, alpha proceeds from 0 to 1 over this time

  • alpha_out_time (float): [Read-Write] When blending out, alpha proceeds from 1 to 0 over this time

  • camera_owner (PlayerCameraManager): [Read-Write] Camera this object is associated with.

  • debug (bool): [Read-Write] If true, enables certain debug visualization features.

  • exclusive (bool): [Read-Write] If true, no other modifiers of same priority allowed.

  • priority (uint8): [Read-Write] Priority value that determines the order in which modifiers are applied. 0 = highest priority, 255 = lowest.

classmethod get_camera_animation_camera_modifier(world_context_object, player_index) → CameraAnimationCameraModifier

Get Camera Animation Camera Modifier

Parameters:

  • world_context_object (Object) –

  • player_index (int32) –

Return type:

CameraAnimationCameraModifier

classmethod get_camera_animation_camera_modifier_from_id(world_context_object, controller_id) → CameraAnimationCameraModifier

Get Camera Animation Camera Modifier from ID

Parameters:

  • world_context_object (Object) –

  • controller_id (int32) –

Return type:

CameraAnimationCameraModifier

classmethod get_camera_animation_camera_modifier_from_player_controller(player_controller) → CameraAnimationCameraModifier

Get Camera Animation Camera Modifier from Player Controller

Parameters:

player_controller (PlayerController) –

Return type:

CameraAnimationCameraModifier

is_camera_animation_active(handle) → bool

Returns whether the given camera animation is playing.

Parameters:

handle (CameraAnimationHandle) – A handle to a previously started camera animation.

Returns:

Whether the corresponding camera animation is playing or not.

Return type:

bool

play_camera_animation(sequence, params) → CameraAnimationHandle

Play a new camera animation sequence.

Parameters:
Return type:

CameraAnimationHandle

stop_all_camera_animations(immediate=False) → None

Stop all camera animation instances.

Parameters:

immediate (bool) – True to stop it right now and ignore blend out, false to let it blend out as indicated.

stop_all_camera_animations_of(sequence, immediate=False) → None

Stop playing all instances of the given camera animation sequence.

Parameters:

  • sequence (CameraAnimationSequence) – The sequence of which to stop all instances.

  • immediate (bool) – True to stop it right now and ignore blend out, false to let it blend out as indicated.

stop_camera_animation(handle, immediate=False) → None

Stops the given camera animation instance.

Parameters:

  • handle (CameraAnimationHandle) –

  • immediate (bool) – True to stop it right now and ignore blend out, false to let it blend out as indicated.