UChaosDestructionListener

Object allowing for retrieving Chaos Destruction data.

API > API/Runtime > API/Runtime/GeometryCollectionEngine

Object allowing for retrieving Chaos Destruction data.

   
Name UChaosDestructionListener
Type class
Header File /Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/ChaosBlueprint.h
Include Path #include "ChaosBlueprint.h"

Syntax

UCLASS (ClassGroup=(Chaos),  
       HideCategories=(Object, ActorComponent, Physics, Rendering, Mobility, LOD),  
       ShowCategories=Trigger, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UChaosDestructionListener : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosDestructionListener ( const FObjectInitializer& ObjectInitializer
)

   ChaosBlueprint.h  

Enums

Protected

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsBreakingEventListeningEnabled uint8 Whether or not collision event listening is enabled. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Breaking Events"
bIsCollisionEventListeningEnabled uint8 Whether or not collision event listening is enabled. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Collision Events"
bIsRemovalEventListeningEnabled uint8 Whether or not removal event listening is enabled. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Removal Events"
bIsTrailingEventListeningEnabled uint8 Whether or not trailing event listening is enabled. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Trailing Events"
BreakingEventRequestSettings FChaosBreakingEventRequestSettings The settings to use for breaking event listening. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Breaking Events"
  • Meta=(EditCondition="bIsBreakingEventListeningEnabled")
ChaosSolverActors TSet< TObjectPtr< AChaosSolverActor > > Which chaos solver actors we're using. If empty, this listener will fallback to the "world" solver. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Solvers"
CollisionEventRequestSettings FChaosCollisionEventRequestSettings The settings to use for collision event listening. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Collision Events"
  • Meta=(EditCondition="bIsCollisionEventListeningEnabled")
GeometryCollectionActors TSet< TObjectPtr< AGeometryCollectionActor > > Which chaos solver actors we're using. If empty, this listener will fallback to the "world" solver. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="GeometryCollections"
OnBreakingEvents FOnChaosBreakingEvents Called when new breaking events are available. ChaosBlueprint.h
  • BlueprintAssignable
OnCollisionEvents FOnChaosCollisionEvents Called when new collision events are available. ChaosBlueprint.h
  • BlueprintAssignable
OnRemovalEvents FOnChaosRemovalEvents Called when new trailing events are available. ChaosBlueprint.h
  • BlueprintAssignable
OnTrailingEvents FOnChaosTrailingEvents Called when new trailing events are available. ChaosBlueprint.h
  • BlueprintAssignable
RemovalEventRequestSettings FChaosRemovalEventRequestSettings The settings to use for removal event listening. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Removal Events"
  • Meta=(EditCondition="bIsRemovalEventListeningEnabled")
TrailingEventRequestSettings FChaosTrailingEventRequestSettings The settings to use for trailing event listening. ChaosBlueprint.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Trailing Events"
  • Meta=(EditCondition="bIsTrailingEventListeningEnabled")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddChaosSolverActor ( AChaosSolverActor* ChaosSolverActor
)

 Dynamically adds a chaos solver to the listener. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void AddGeometryCollectionActor ( AGeometryCollectionActor* GeometryCollectionActor
)

 Dynamically adds a chaos solver to the listener. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void HandleBreakingEvents ( const Chaos::FBreakingEventData& BreakingData
)

   ChaosBlueprint.h  

void HandleCollisionEvents ( const Chaos::FCollisionEventData& CollisionData
)

 Chaos Event Handlers. ChaosBlueprint.h  

void HandleRemovalEvents ( const Chaos::FRemovalEventData& RemovalData
)

   ChaosBlueprint.h  

void HandleTrailingEvents ( const Chaos::FTrailingEventData& TrailingData
)

   ChaosBlueprint.h  

bool IsEventListening()

 Returns if the destruction listener is listening to any events. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")
  ChaosBlueprint.h  

void RegisterChaosEvents ( FPhysScene* Scene
)

   ChaosBlueprint.h  

void RemoveChaosSolverActor ( AChaosSolverActor* ChaosSolverActor
)

 Dynamically removes a chaos solver from the listener. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void RemoveGeometryCollectionActor ( AGeometryCollectionActor* GeometryCollectionActor
)

 Dynamically removes a chaos solver from the listener. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetBreakingEventEnabled ( bool bIsEnabled
)

 Enables or disables breaking event listening. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetBreakingEventRequestSettings ( const FChaosBreakingEventRequestSettings& InSettings
)

 Sets breaking event request settings dynamically. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetBreakingFilter ( TSharedPtr< FChaosBreakingEventFilter > InBreakingFilter
)

   ChaosBlueprint.h  

void SetCollisionEventEnabled ( bool bIsEnabled
)

 Enables or disables collision event listening. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetCollisionEventRequestSettings ( const FChaosCollisionEventRequestSettings& InSettings
)

 Sets collision event request settings dynamically. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetCollisionFilter ( TSharedPtr< FChaosCollisionEventFilter > InCollisionFilter
)

   ChaosBlueprint.h  

void SetRemovalEventEnabled ( bool bIsEnabled
)

 Enables or disables removal event listening. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetRemovalEventRequestSettings ( const FChaosRemovalEventRequestSettings& InSettings
)

 Sets removal event request settings dynamically. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetRemovalFilter ( TSharedPtr< FChaosRemovalEventFilter > InRemovalFilter
)

   ChaosBlueprint.h  

void SetTrailingEventEnabled ( bool bIsEnabled
)

 Enables or disables trailing event listening. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetTrailingEventRequestSettings ( const FChaosTrailingEventRequestSettings& InSettings
)

 Sets trailing event request settings dynamically. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SetTrailingFilter ( TSharedPtr< FChaosTrailingEventFilter > InTrailingFilter
)

   ChaosBlueprint.h  

void SortBreakingEvents ( TArray< FChaosBreakingEventData >& BreakingEvents,
EChaosBreakingSortMethod SortMethod
)

 Sorts breaking events according to the given sort method ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SortCollisionEvents ( TArray< FChaosCollisionEventData >& CollisionEvents,
EChaosCollisionSortMethod SortMethod
)

 Sorts collision events according to the given sort method ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SortRemovalEvents ( TArray< FChaosRemovalEventData >& RemovalEvents,
EChaosRemovalSortMethod SortMethod
)

 Sorts removal events according to the given sort method. ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void SortTrailingEvents ( TArray< FChaosTrailingEventData >& TrailingEvents,
EChaosTrailingSortMethod SortMethod
)

 Sorts trailing events according to the given sort method ChaosBlueprint.h
  • BlueprintCallable
  • Category="Destruction Listener"
  • Meta=(WorldContext="WorldContextObject")

void UnregisterChaosEvents ( FPhysScene* Scene
)

   ChaosBlueprint.h  
  ChaosBlueprint.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   ChaosBlueprint.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   ChaosBlueprint.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   ChaosBlueprint.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ChaosBlueprint.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page