`unreal.MoverSimulation`¶

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

Bases: Object

WIP Base class for a Mover simulation. The simulation is intended to be the thing that updates the Mover state and should be safe to run on an async thread

C++ Source:

Plugin: Mover
Module: Mover
File: MoverSimulation.h

attempt_teleport(time_step, target_transform, use_actor_rotation) → MoverSyncState¶

Attempt to teleport to TargetTransform. The teleport is not guaranteed to happen. This function is meant to be called by an instant movement effect as part of its effect application. If it succeeds a FTeleportSucceededEventData will be emitted, if it fails a FTeleportFailedEventData will be sent.

Parameters:

time_step (MoverTimeStep) – The time step of the current step or substep being simulated. This will come from the ApplyMovementEffect function.
target_transform (Transform) – The transform to teleport to. In the case bUseActorRotation is true, the rotation of this transform will be ignored.
use_actor_rotation (bool) – If true, the rotation will not be modified upon teleportation. If false, the rotation in TargetTransform will be used to orient the teleported.

Returns:

output_state (MoverSyncState): This is the sync state that me modified as a result of the application of this effect. Like TimeStep, this should come from the ApplyMovementEffect function.

Return type: