Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > FScopedMovementUpdate

Light Theme

Dark Theme

FScopedMovementUpdate

[FScopedMovementUpdate](API\Runtime\Engine\Components\FScopedMovementUpdate) creates a new movement scope, within which propagation of moves may be deferred until the end of the outermost scope that does not defer updates.

Windows

MacOS

Linux

Inheritance Hierarchy

FNoncopyable

FScopedMovementUpdate

UMovieSceneDeferredComponentMovementSystem::FScopedSequencerMovementUpdate

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/SceneComponent.h
Include	#include "Components/SceneComponent.h"

Syntax

class FScopedMovementUpdate : private FNoncopyable

Remarks

FScopedMovementUpdate creates a new movement scope, within which propagation of moves may be deferred until the end of the outermost scope that does not defer updates. Moves within this scope will avoid updates such as UpdateBounds(), OnUpdateTransform(), UpdatePhysicsVolume(), UpdateChildTransforms() etc until the move is committed (which happens when the last deferred scope goes out of context).

that non-deferred scopes are not allowed within outer scopes that defer updates, and any attempt to use one will change the inner scope to use deferred updates.

Variables

		Name	Description
	uint8: 1	bDeferUpdates
	uint8: 1	bHasMoved
	TScopedBlocking...	BlockingHits
	uint8: 1	bRequireOverlapsEventFlag
	EOverlapState	CurrentOverlapState
	int32	FinalOverlapCandidatesIndex
	FVector	InitialRelativeLocation
	FRotator	InitialRelativeRotation
	FVector	InitialRelativeScale
	FTransform	InitialTransform
	FScopedMovement...	OuterDeferredScope
	USceneComponent...	Owner
	TScopedOverlapI...	PendingOverlaps
	ETeleportType	TeleportType

Constructors

	Name	Description
	FScopedMovementUpdate ( USceneComponent* Component, EScopedUpdate::Type ScopeBehavior, bool bRequireOverlapsEventFlagToQue... )

Destructors

	Name	Description
	~FScopedMovementUpdate()

Functions

	Name	Description
void	AppendBlockingHitAfterMove ( const FHitResult& Hit )	Add blocking hit that will get processed once the move is committed.
void	AppendOverlapsAfterMove ( const TOverlapArrayView& NewPendin..., bool bSweep, bool bIncludesOverlapsAtEnd )	Add overlaps to the queued overlaps array.
void	ForceOverlapUpdate()	Force full overlap update once this scope finishes.
const FScope...	GetOuterDeferredScope()	Get the scope containing this scope. A scope only has an outer scope if they both defer updates.
TOptional< T...	GetOverlapsAtEnd ( UPrimitiveComponent& PrimComponent, TArray< FOverlapInfo, AllocatorType..., bool bTransformChanged )	Fills in the list of overlaps at the end location (in EndOverlaps).
const TScope...	GetPendingBlockingHits()	Returns the list of pending blocking hits, which will be used for notifications once the move is committed.
const TScope...	GetPendingOverlaps()	Returns the pending overlaps within this scope.
bool	HasMoved ( EHasMovedTransformOption CheckTrans... )	Returns whether movement has occurred at all during this scope, optionally checking if the transform is different (since changing scale does not go through a move).
bool	HasPendingOverlaps()	Returns true if there are pending overlaps queued in this scope.
void	InvalidateCurrentOverlaps()	Clear overlap state at current location, we don't know what it is.
bool	IsDeferringUpdates()	Return true if deferring updates, false if updates are applied immediately.
bool	IsTransformDirty()	Returns true if the Component's transform differs from that at the start of the scoped update.
void	KeepCurrentOverlapsAfterRotation ( bool bSweep )	Keep current pending overlaps after a move but make
bool	RequiresOverlapsEventFlag()	Returns true if we require GetGenerateOverlapEvents() on both the moving object and the overlapped object to add them to the pending overlaps list.
void	RevertMove()	Revert movement to the initial location of the Component at the start of the scoped update.
void	SetHasTeleported ( ETeleportType InTeleportType )	Registers that this move is a teleport
bool	SetWorldLocationAndRotation ( FVector NewLocation, const FQuat& NewQuat, bool bNoPhysics, ETeleportType Teleport )

Enums

	Name	Description
	EHasMovedTransformOption
	EOverlapState

Typedefs

Name	Description
TScopedBlockingHitArray
TScopedOverlapInfoArray

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss