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 > Plugins > ApexDestruction > UDestructibleComponent

Light Theme

Dark Theme

UDestructibleComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

USkinnedMeshComponent

UDestructibleComponent

References

Module	ApexDestruction
Header	/Engine/Plugins/Runtime/ApexDestruction/Source/ApexDestruction/Public/DestructibleComponent.h
Include	#include "DestructibleComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=Physics,
       HideCategories=(Object, Mesh, "Components|SkinnedMesh", Mirroring, Activation, "Components|Activation"),
       Config=Engine, EditInlineNew, Meta=(BlueprintSpawnableComponent))
class UDestructibleComponent :
    public USkinnedMeshComponent,
    public IDestructibleInterface

Variables

	Name	Description
bool	bEnableHardSleeping	Enable "hard sleeping" for destruction-generated PxActors.
uint32: 1	bFractureEffectOverride	If set, use this actor's fracture effects instead of the asset's fracture effects.
UDestructibleMe...	DestructibleMesh	Provide a blueprint interface for setting the destructible mesh
TArray< struct ...	FractureEffects	Fracture effects for each fracture level. Used only if Fracture Effect Override is set.
float	LargeChunkThreshold	The minimum size required to treat chunks as Large.
FComponentFract...	OnComponentFracture	Called when a component is touched
TArray< FPhysxU...	PhysxChunkUserData	User data wrapper for the chunks passed to physx

Constructors

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

Functions

	Name	Description
int32	BoneIdxToChunkIdx ( int32 BoneIdx )
int32	ChunkIdxToBoneIdx ( int32 ChunkIdx )
UDestructibl...	GetDestructibleMesh()
bool	IsChunkLarge ( physx::PxRigidActor* ChunkActo... )
void	SetChunkVisible ( int32 ChunkIndex, bool bInVisible )	This method makes a chunk (fractured piece) visible or invisible.
void	SetChunkWorldRT ( int32 ChunkIndex, const FQuat& WorldRotation, const FVector& WorldTranslation )	This method sets a chunk's (fractured piece's) world rotation and translation.
void	SetDestructibleMesh ( UDestructibleMesh* NewMesh )

Overridden from USkinnedMeshComponent

	Name	Description
void	RefreshBoneTransforms ( FActorComponentTickFunction* T... )	Update functions Refresh Bone Transforms Each class will need to implement this function Ideally this function should be atomic (not relying on Tick or any other update.)
void	SetSkeletalMesh ( USkeletalMesh* NewMesh, bool bReinitPose )	Change the SkeletalMesh that is rendered for this Component.
bool	ShouldUpdateTransform ( bool bLODHasChanged )	Should update transform in Tick

Overridden from UPrimitiveComponent

	Name	Description
void	AddForce ( FVector Force, FName BoneName, bool bAccelChange )	Add a force to a single rigid body.
void	AddForceAtLocation ( FVector Force, FVector Location, FName BoneName )	Add a force to a single rigid body at a particular location in world space.
void	AddForceAtLocationLocal ( FVector Force, FVector Location, FName BoneName )	Add a force to a single rigid body at a particular location.
void	AddImpulse ( FVector Impulse, FName BoneName, bool bVelChange )	Add an impulse to a single rigid body. Good for one time instant burst.
void	AddImpulseAtLocation ( FVector Impulse, FVector Location, FName BoneName )	Add an impulse to a single rigid body at a specific location.
void	AddRadialForce ( FVector Origin, float Radius, float Strength, ERadialImpulseFalloff Falloff, bool bAccelChange )	Add a force to all bodies in this component, originating from the supplied world-space location.
void	AddRadialImpulse ( FVector Origin, float Radius, float Strength, ERadialImpulseFalloff Falloff, bool bVelChange )	Add an impulse to all rigid bodies in this component, radiating out from the specified position.
bool	CanEditSimulatePhysics()	Determines whether or not the simulate physics setting can be edited interactively on this component
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.
FBodyInstanc...	GetBodyInstance ( FName BoneName, bool bGetWelded )	Returns BodyInstance of the component.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
bool	LineTraceComponent ( FHitResult& OutHit, const FVector Start, const FVector End, const FCollisionQueryParams& Param... )	Trace a ray against just this component.
void	ReceiveComponentDamage ( float DamageAmount, FDamageEvent const& DamageEvent, AController* EventInstigator, AActor* DamageCauser )	Event called when a component is 'damaged', allowing for component class specific behaviour
void	SetCollisionEnabled ( ECollisionEnabled::Type NewType )	Controls what kind of collision is enabled for this body
void	SetCollisionProfileName ( FName InCollisionProfileName, bool bUpdateOverlaps )	Set Collision Profile Name This function is called by constructors when they set ProfileName This will change current CollisionProfileName to be this, and overwrite Collision Setting
void	SetCollisionResponseToAllChannels ( ECollisionResponse NewResponse )	Changes all ResponseToChannels container for this PrimitiveComponent. to be NewResponse
void	SetCollisionResponseToChannel ( ECollisionChannel Channel, ECollisionResponse NewResponse )	Changes a member of the ResponseToChannels container for this PrimitiveComponent.
void	SetCollisionResponseToChannels ( const FCollisionResponseContainer&... )	Changes the whole ResponseToChannels container for this PrimitiveComponent.
void	SetEnableGravity ( bool bGravityEnabled )	Enables/disables whether this component is affected by gravity.
void	SetMaterial ( int32 ElementIndex, UMaterialInterface* Material )	Changes the material applied to an element of the mesh.
void	SetSimulatePhysics ( bool bSimulate )	Sets whether or not a single body should use physics simulation, or should be 'fixed' (kinematic).
bool	SweepComponent ( FHitResult& OutHit, const FVector Start, const FVector End, const FQuat& ShapeWorldRotation, const FCollisionShape& CollisionSh..., bool bTraceComplex )	Trace a shape against just this component.
void	WakeRigidBody ( FName BoneName )	'Wake' physics simulation for a single body.

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
FTransform	GetSocketTransform ( FName InSocketName, ERelativeTransformSpace TransformSp... )	Get world-space socket transform.
bool	IsAnySimulatingPhysics()	Returns whether the specified body is currently using physics simulation
void	OnUpdateTransform ( EUpdateTransformFlags UpdateTransfo..., ETeleportType Teleport )	Native callback when this component is moved

Overridden from UActorComponent

	Name	Description
void	Activate ( bool bReset )	Activates the SceneComponent, should be overridden by native child classes.
void	Deactivate()	Deactivates the SceneComponent.
void	OnActorEnableCollisionChanged()	Called on each component when the Actor's bEnableCollisionChanged flag changes
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IDestructibleInterface

		Name	Description
	void	ApplyDamage ( float DamageAmount, const FVector& HitLocation, const FVector& ImpulseDir, float ImpulseStrength )	Take damage.
	void	ApplyRadiusDamage ( float BaseDamage, const FVector& HurtOrigin, float DamageRadius, float ImpulseStrength, bool bFullDamage )	Take radius damage.

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

Take our survey

Dismiss