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 > GeometryCollectionEngine > UChaosDestructionListener

Light Theme

Dark Theme

UChaosDestructionListener

Object allowing for retrieving Chaos Destruction data.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UChaosDestructionListener

References

Module	GeometryCollectionEngine
Header	/Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/ChaosBlueprint.h
Include	#include "ChaosBlueprint.h"

Syntax

class UChaosDestructionListener : public USceneComponent

Remarks

Object allowing for retrieving Chaos Destruction data.

Variables

	Name	Description
FThreadSafeBool	bChanged
uint8: 1	bIsBreakingEventListeningEnabled	Whether or not collision event listening is enabled.
uint8: 1	bIsCollisionEventListeningEnabled	Whether or not collision event listening is enabled.
uint8: 1	bIsRemovalEventListeningEnabled	Whether or not removal event listening is enabled.
uint8: 1	bIsTrailingEventListeningEnabled	Whether or not trailing event listening is enabled.
FChaosBreakingE...	BreakingEventRequestSettings	The settings to use for breaking event listening.
TSharedPtr< FCh...	ChaosBreakingFilter
TSharedPtr< FCh...	ChaosCollisionFilter
FTransform	ChaosComponentTransform
TSharedPtr< FCh...	ChaosRemovalFilter
TSet< TObjectPt...	ChaosSolverActors	Which chaos solver actors we're using. If empty, this listener will fallback to the "world" solver.
TSharedPtr< FCh...	ChaosTrailingFilter
FChaosCollision...	CollisionEventRequestSettings	The settings to use for collision event listening.
TSet< TObjectPt...	GeometryCollectionActors	Which chaos solver actors we're using. If empty, this listener will fallback to the "world" solver.
TArray< const F...	GeometryCollectionPhysicsProxies	The list of GeometryCollectionPhysicsProxy, used to retrieve destruction events.
float	LastBreakingDataTimeStamp
float	LastCollisionDataTimeStamp
float	LastRemovalDataTimeStamp
float	LastTrailingDataTimeStamp
FOnChaosBreakin...	OnBreakingEvents	Called when new breaking events are available.
FOnChaosCollisi...	OnCollisionEvents	Called when new collision events are available.
FOnChaosRemoval...	OnRemovalEvents	Called when new trailing events are available.
FOnChaosTrailin...	OnTrailingEvents	Called when new trailing events are available.
Chaos::FBreakin...	RawBreakingDataArray
Chaos::FCollisi...	RawCollisionDataArray	The raw data arrays derived from the solvers.
Chaos::FRemoval...	RawRemovalDataArray
Chaos::FTrailin...	RawTrailingDataArray
FChaosRemovalEv...	RemovalEventRequestSettings	The settings to use for removal event listening.
TSet< Chaos::FP...	Solvers	The list of rigid body solvers, used to retrieve destruction events.
FThreadSafeCoun...	TaskState
FChaosTrailingE...	TrailingEventRequestSettings	The settings to use for trailing event listening.

Constructors

	Name	Description
	UChaosDestructionListener ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddChaosSolverActor ( AChaosSolverActor* ChaosSolver... )	Dynamically adds a chaos solver to the listener.
void	AddGeometryCollectionActor ( AGeometryCollectionActor* Geom... )	Dynamically adds a chaos solver to the listener.
void	HandleBreakingEvents ( const Chaos::FBreakingEventData& B... )
void	HandleCollisionEvents ( const Chaos::FCollisionEventData& ... )	Chaos Event Handlers.
void	HandleRemovalEvents ( const Chaos::FRemovalEventData& Re... )
void	HandleTrailingEvents ( const Chaos::FTrailingEventData& T... )
bool	IsEventListening()	Returns if the destruction listener is listening to any events.
void	RegisterChaosEvents ( TSharedPtr< FPhysScene_Chaos > Scen... )
void	RegisterChaosEvents ( FPhysScene* Scene )
void	RemoveChaosSolverActor ( AChaosSolverActor* ChaosSolver... )	Dynamically removes a chaos solver from the listener.
void	RemoveGeometryCollectionActor ( AGeometryCollectionActor* Geom... )	Dynamically removes a chaos solver from the listener.
void	SetBreakingEventEnabled ( bool bIsEnabled )	Enables or disables breaking event listening.
void	SetBreakingEventRequestSettings ( const FChaosBreakingEventRequestSet... )	Sets breaking event request settings dynamically.
void	SetBreakingFilter ( TSharedPtr< FChaosBreakingEventFilt... )
void	SetCollisionEventEnabled ( bool bIsEnabled )	Enables or disables collision event listening.
void	SetCollisionEventRequestSettings ( const FChaosCollisionEventRequestSe... )	Sets collision event request settings dynamically.
void	SetCollisionFilter ( TSharedPtr< FChaosCollisionEventFil... )
void	SetRemovalEventEnabled ( bool bIsEnabled )	Enables or disables removal event listening.
void	SetRemovalEventRequestSettings ( const FChaosRemovalEventRequestSett... )	Sets removal event request settings dynamically.
void	SetRemovalFilter ( TSharedPtr< FChaosRemovalEventFilte... )
void	SetTrailingEventEnabled ( bool bIsEnabled )	Enables or disables trailing event listening.
void	SetTrailingEventRequestSettings ( const FChaosTrailingEventRequestSet... )	Sets trailing event request settings dynamically.
void	SetTrailingFilter ( TSharedPtr< FChaosTrailingEventFilt... )
void	SortBreakingEvents ( TArray< FChaosBreakingEventData >&..., EChaosBreakingSortMethod SortMethod )	Sorts breaking events according to the given sort method.
void	SortCollisionEvents ( TArray< FChaosCollisionEventData > ..., EChaosCollisionSortMethod SortMetho... )	Sorts collision events according to the given sort method.
void	SortRemovalEvents ( TArray< FChaosRemovalEventData >& ..., EChaosRemovalSortMethod SortMethod )	Sorts removal events according to the given sort method.
void	SortTrailingEvents ( TArray< FChaosTrailingEventData >&..., EChaosTrailingSortMethod SortMethod )	Sorts trailing events according to the given sort method.
void	UnregisterChaosEvents ( FPhysScene* Scene )
void	UnregisterChaosEvents ( TSharedPtr< FPhysScene_Chaos > Scen... )

Overridden from UActorComponent

	Name	Description
void	BeginPlay()	Begins Play for the component.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Ends gameplay for this component.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Enums

	Name	Description
	ETaskState	Task state enumeration used to track if there is an async processing task in-flight.