unreal.MatineeActor

class unreal.MatineeActor(outer=None, name='None')

Bases: unreal.Actor

Matinee Actor

C++ Source:

  • Module: Engine
  • File: MatineeActor.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_tick_before_begin_play (bool): [Read-Write] Whether we allow this Actor to tick before it receives the BeginPlay event. Normally we don’t tick actors until after BeginPlay; this setting allows this behavior to be overridden. This Actor must be able to tick for this setting to be relevant.
  • always_relevant (bool): [Read-Write] Always relevant for network (overrides bOnlyRelevantToOwner).
  • auto_destroy_when_finished (bool): [Read-Write] If true then destroy self when “finished”, meaning all relevant components report that they are done and no timelines or timers are in flight.
  • auto_receive_input (AutoReceiveInput): [Read-Write] Automatically registers this actor to receive input from a player.
  • block_input (bool): [Read-Write] If true, all input on the stack below this actor will not be considered
  • can_be_damaged (bool): [Read-Write] Whether this actor can take damage. Must be true for damage events (e.g. ReceiveDamage()) to be called. https://www.unrealengine.com/blog/damage-in-ue4: TakeDamage(), ReceiveDamage():
  • can_be_in_cluster (bool): [Read-Write] If true, this actor can be put inside of a GC Cluster to improve Garbage Collection performance
  • client_side_only (bool): [Read-Write] Indicates that this interpolation does not affect gameplay. This means that: -it is not replicated via MatineeActor -it is not ticked if no affected Actors are visible -on dedicated servers, it is completely ignored
  • custom_time_dilation (float): [Read-Write] Allow each actor to run at a different time speed. The DeltaTime for a frame is multiplied by the global TimeDilation (in WorldSettings) and this CustomTimeDilation for this actor’s tick.
  • disable_look_at_input (bool): [Read-Write] Disable LookAt Input from player during play
  • disable_movement_input (bool): [Read-Write] Disable Input from player during play
  • disable_radio_filter (bool): [Read-Write] If true, disables the realtime radio effect
  • enable_auto_lod_generation (bool): [Read-Write] If true, and if World setting has bEnableHierarchicalLOD equal to true, then it will generate LODActor from groups of clustered Actor
  • find_camera_component_when_view_target (bool): [Read-Write] If true, this actor should search for an owned camera component to view through when used as a view target.
  • force_start_pos (bool): [Read-Write] Lets you force the sequence to always start at ForceStartPosition
  • force_start_position (float): [Read-Write] Time position to always start at if bForceStartPos is set to true.
  • generate_overlap_events_during_level_streaming (bool): [Read-Write] If true, this actor will generate overlap events when spawned as part of level streaming. You might enable this is in the case where a streaming level loads around an actor and you want overlaps to trigger.
  • hidden (bool): [Read-Write] Allows us to only see this Actor in the Editor, and not in the actual game. SetActorHiddenInGame():
  • hide_hud (bool): [Read-Write] Hide HUD during play
  • hide_player (bool): [Read-Write] Hide Player Pawn during play
  • ignores_origin_shifting (bool): [Read-Write] Whether this actor should not be affected by world origin shifting.
  • initial_life_span (float): [Read-Write] How long this Actor lives before dying, 0=forever. Note this is the INITIAL value and should not be modified once play has begun.
  • input_priority (int32): [Read-Write] The priority of this input component when pushed in to the stack.
  • instigator (Pawn): [Read-Write] Pawn responsible for damage and other gameplay events caused by this actor.
  • interp_position (float): [Read-Only] Interp Position
  • is_editor_only_actor (bool): [Read-Write] Whether this actor is editor-only. Use with care, as if this actor is referenced by anything else that reference will be NULL in cooked builds
  • is_playing (bool): [Read-Only] properties that may change on InterpAction that we need to notify clients about, since the object’s properties will not be replicated
  • is_skippable (bool): [Read-Write] Lets you skip the matinee with the CANCELMATINEE exec command. Triggers all events to the end along the way.
  • looping (bool): [Read-Write] If sequence should pop back to beginning when finished. Note, if true, will never get Completed/Reversed events - sequence must be explicitly Stopped.
  • matinee_data (InterpData): [Read-Write] The matinee data used by this actor
  • min_net_update_frequency (float): [Read-Write] Used to determine what rate to throttle down to when replicated properties are changing infrequently
  • net_cull_distance_squared (float): [Read-Write] Square of the max distance from the client’s viewpoint that this actor is relevant and will be replicated.
  • net_dormancy (NetDormancy): [Read-Write] Dormancy setting for actor to take itself off of the replication list without being destroyed on clients.
  • net_load_on_client (bool): [Read-Write] This actor will be loaded on network clients during map load
  • net_priority (float): [Read-Write] Priority for this actor when checking for replication in a low bandwidth or saturated situation, higher priority means it is more likely to replicate
  • net_update_frequency (float): [Read-Write] How often (per second) this actor will be considered for replication, used to determine NetUpdateTime
  • net_use_owner_relevancy (bool): [Read-Write] If actor has valid Owner, call Owner’s IsNetRelevantFor and GetNetPriority
  • no_reset_on_rewind (bool): [Read-Write] If true, when rewinding this interpolation, reset the ‘initial positions’ of any RelateToInitial movements to the current location. This allows the next loop of movement to proceed from the current locations.
  • on_actor_begin_overlap (ActorBeginOverlapSignature): [Read-Write] Called when another actor begins to overlap this actor, for example a player walking into a trigger. For events when objects have a blocking collision, for example a player hitting a wall, see ‘Hit’ events. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_end_overlap (ActorEndOverlapSignature): [Read-Write] Called when another actor stops overlapping this actor. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_hit (ActorHitSignature): [Read-Write] Called when this Actor hits (or is hit by) something solid. This could happen due to things like Character movement, using Set Location with ‘sweep’ enabled, or physics simulation. For events when objects overlap (e.g. walking into a trigger) see the ‘Overlap’ event. For collisions during physics simulation to generate hit events, ‘Simulation Generates Hit Events’ must be enabled.:
  • on_begin_cursor_over (ActorBeginCursorOverSignature): [Read-Write] Called when the mouse cursor is moved over this actor if mouse over events are enabled in the player controller.
  • on_clicked (ActorOnClickedSignature): [Read-Write] Called when the left mouse button is clicked while the mouse is over this actor and click events are enabled in the player controller.
  • on_destroyed (ActorDestroyedSignature): [Read-Write] Event triggered when the actor has been explicitly destroyed.
  • on_end_cursor_over (ActorEndCursorOverSignature): [Read-Write] Called when the mouse cursor is moved off this actor if mouse over events are enabled in the player controller.
  • on_end_play (ActorEndPlaySignature): [Read-Write] Event triggered when the actor is being deleted or removed from a level.
  • on_input_touch_begin (ActorOnInputTouchBeginSignature): [Read-Write] Called when a touch input is received over this actor when touch events are enabled in the player controller.
  • on_input_touch_end (ActorOnInputTouchEndSignature): [Read-Write] Called when a touch input is received over this component when touch events are enabled in the player controller.
  • on_input_touch_enter (ActorBeginTouchOverSignature): [Read-Write] Called when a finger is moved over this actor when touch over events are enabled in the player controller.
  • on_input_touch_leave (ActorEndTouchOverSignature): [Read-Write] Called when a finger is moved off this actor when touch over events are enabled in the player controller.
  • on_pause (OnMatineeEvent): [Read-Write] Event triggered when the matinee is paused for whatever reason
  • on_play (OnMatineeEvent): [Read-Write] Event triggered when the matinee is played for whatever reason
  • on_released (ActorOnReleasedSignature): [Read-Write] Called when the left mouse button is released while the mouse is over this actor and click events are enabled in the player controller.
  • on_stop (OnMatineeEvent): [Read-Write] Event triggered when the matinee is stopped for whatever reason
  • on_take_any_damage (TakeAnyDamageSignature): [Read-Write] Called when the actor is damaged in any way.
  • on_take_point_damage (TakePointDamageSignature): [Read-Write] Called when the actor is damaged by point damage.
  • on_take_radial_damage (TakeRadialDamageSignature): [Read-Write] Called when the actor is damaged by radial damage.
  • only_relevant_to_owner (bool): [Read-Write] If true, this actor is only relevant to its owner. If this flag is changed during play, all non-owner channels would need to be explicitly closed.
  • optimize_bp_component_data (bool): [Read-Write] Whether to cook additional data to speed up spawn events at runtime for any Blueprint classes based on this Actor. This option may slightly increase memory usage in a cooked build.
  • pivot_offset (Vector): [Read-Write] Local space pivot offset for the actor, only used in the editor
  • play_on_level_load (bool): [Read-Write] If true, the matinee will play when the level is loaded.
  • play_rate (float): [Read-Write] Time multiplier for playback.
  • preferred_split_screen_num (int32): [Read-Write] Preferred local viewport number (when split screen is active) the director track should associate with, or zero for ‘all’.
  • primary_actor_tick (ActorTickFunction): [Read-Write] Primary Actor tick function, which calls TickActor(). Tick functions can be configured to control whether ticking is enabled, at what time during a frame the update occurs, and to set up tick dependencies. https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/Engine/FTickFunction/: AddTickPrerequisiteActor(), AddTickPrerequisiteComponent():
  • relevant_for_level_bounds (bool): [Read-Write] If true, this actor’s component’s bounds will be included in the level’s bounding box unless the Actor’s class has overridden IsLevelBoundsRelevant
  • replay_rewindable (bool): [Read-Write] If true, this actor will only be destroyed during scrubbing if the replay is set to a time before the actor existed. Otherwise, RewindForReplay will be called if we detect the actor needs to be reset. Note, this Actor must not be destroyed by gamecode, and RollbackViaDeletion may not be used.
  • replicate_movement (bool): [Read-Write] If true, replicate movement/location related properties. Actor must also be set to replicate. SetReplicates(): https://docs.unrealengine.com/latest/INT/Gameplay/Networking/Replication/:
  • replicated_movement (RepMovement): [Read-Write] Used for replication of our RootComponent’s position and velocity
  • replicates (bool): [Read-Write] If true, this actor will replicate to remote machines SetReplicates():
  • rewind_if_already_playing (bool): [Read-Write] Only used if bRewindOnPlay if true. Defines what should happen if the Play input is activated while currently playing. If true, hitting Play while currently playing will pop the position back to the start and begin playback over again. If false, hitting Play while currently playing will do nothing.
  • rewind_on_play (bool): [Read-Write] If true, sequence will rewind itself back to the start each time the Play input is activated.
  • root_component (SceneComponent): [Read-Write] The component that defines the transform (location, rotation, scale) of this Actor in the world, all other components must be attached to this one somehow
  • skip_update_if_not_visible (bool): [Read-Write] if bClientSideOnly is true, whether this matinee should be completely skipped if none of the affected Actors are visible
  • spawn_collision_handling_method (SpawnActorCollisionHandlingMethod): [Read-Write] Controls how to handle spawning this actor in a situation where it’s colliding with something else. “Default” means AlwaysSpawn here.
  • sprite_scale (float): [Read-Write] The scale to apply to any billboard components in editor builds (happens in any WITH_EDITOR build, including non-cooked games).
  • tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing.
change_playback_direction() → None

Changes the direction of playback (go in reverse if it was going forward, or vice versa)

client_side_only

**(bool)* – [Read-Write] Indicates that this interpolation does not affect gameplay. This means that* – -it is not replicated via MatineeActor -it is not ticked if no affected Actors are visible -on dedicated servers, it is completely ignored

disable_look_at_input

(bool) – [Read-Write] Disable LookAt Input from player during play

disable_movement_input

(bool) – [Read-Write] Disable Input from player during play

disable_radio_filter

(bool) – [Read-Write] If true, disables the realtime radio effect

enable_group_by_name(group_name, enable) → None

Enable Group by Name

Parameters:
  • group_name (str) –
  • enable (bool) –
force_start_pos

(bool) – [Read-Write] Lets you force the sequence to always start at ForceStartPosition

force_start_position

(float) – [Read-Write] Time position to always start at if bForceStartPos is set to true.

hide_hud

(bool) – [Read-Write] Hide HUD during play

hide_player

(bool) – [Read-Write] Hide Player Pawn during play

interp_position

(float) – [Read-Only] Interp Position

is_playing

(bool) – [Read-Only] properties that may change on InterpAction that we need to notify clients about, since the object’s properties will not be replicated

is_skippable

(bool) – [Read-Write] Lets you skip the matinee with the CANCELMATINEE exec command. Triggers all events to the end along the way.

looping

(bool) – [Read-Write] If sequence should pop back to beginning when finished. Note, if true, will never get Completed/Reversed events - sequence must be explicitly Stopped.

matinee_data

(InterpData) – [Read-Write] The matinee data used by this actor

no_reset_on_rewind

(bool) – [Read-Write] If true, when rewinding this interpolation, reset the ‘initial positions’ of any RelateToInitial movements to the current location. This allows the next loop of movement to proceed from the current locations.

on_pause

(OnMatineeEvent) – [Read-Write] Event triggered when the matinee is paused for whatever reason

on_play

(OnMatineeEvent) – [Read-Write] Event triggered when the matinee is played for whatever reason

on_stop

(OnMatineeEvent) – [Read-Write] Event triggered when the matinee is stopped for whatever reason

pause() → None

Hold playback at its current position. Calling Pause again will continue playback in its current direction.

play() → None

Begin playback of the matinee. Only called in game. Will then advance Position by (PlayRate * Deltatime) each time the matinee is ticked.

play_on_level_load

(bool) – [Read-Write] If true, the matinee will play when the level is loaded.

play_rate

(float) – [Read-Write] Time multiplier for playback.

preferred_split_screen_num

(int32) – [Read-Write] Preferred local viewport number (when split screen is active) the director track should associate with, or zero for ‘all’.

reverse() → None

Similar to play, but the playback will go backwards until the beginning of the sequence is reached.

rewind_if_already_playing

(bool) – [Read-Write] Only used if bRewindOnPlay if true. Defines what should happen if the Play input is activated while currently playing. If true, hitting Play while currently playing will pop the position back to the start and begin playback over again. If false, hitting Play while currently playing will do nothing.

rewind_on_play

(bool) – [Read-Write] If true, sequence will rewind itself back to the start each time the Play input is activated.

set_looping_state(new_looping) → None

Change the looping behaviour of this matinee

Parameters:new_looping (bool) –
set_position(new_position, jump=False) → None

Set the position of the interpolation. if the interpolation is not currently active, this function doesn’t send any Kismet events:

Parameters:
  • new_position (float) – the new position to set the interpolation to
  • jump (bool) – if true, teleport to the new position (don’t trigger any events between the old and new positions, etc)
skip_update_if_not_visible

(bool) – [Read-Write] if bClientSideOnly is true, whether this matinee should be completely skipped if none of the affected Actors are visible

stop() → None

Stops playback at the current position