Class DestructionData

Contains the computed fracture data for a mesh.

DestructionData holds all the pieces generated by fracturing a mesh, along with metadata about the original mesh and fracture settings. This data can be used at runtime to spawn debris when a destructable object is destroyed.

Hierarchy

  • FrameworkObject
    • DestructionData

Constructors

constructor

Accessors

averageMass averageVolume interiorMaterial interiorMaterialHandle isValid originalBounds pieceCount pieces settings topLevelPieceCount totalMass totalVolume

Methods

activateAllMeshes activateTopLevelMeshes areMeshesActivated clear getPiece

Constructors

Protectedconstructor

  • new DestructionData(isInternalConstructor?): DestructionData

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns DestructionData

Accessors

averageMass

  • get averageMass(): number

  • Gets the average mass across all pieces. Used for damage threshold calculation.

    Returns number

averageVolume

  • get averageVolume(): number

  • Gets the average volume across all pieces. Used for damage threshold calculation.

    Returns number

interiorMaterial

  • get interiorMaterial(): Material

  • Gets the interior material used for cut surfaces.

    Returns Material

interiorMaterialHandle

isValid

  • get isValid(): boolean

  • Determines if this destruction data is valid and ready to use.

    Returns boolean

originalBounds

pieceCount

  • get pieceCount(): number

  • Gets the number of pieces.

    Returns number

pieces

settings

topLevelPieceCount

  • get topLevelPieceCount(): number

  • Gets the count of top-level pieces (pieces stored directly, not as children).

    Returns number

totalMass

  • get totalMass(): number

  • Gets the total mass of all pieces combined.

    Returns number

totalVolume

  • get totalVolume(): number

  • Gets the total volume of all pieces combined.

    Returns number

Methods

activateAllMeshes

  • activateAllMeshes(): void

  • Activates render and physics meshes for ALL pieces recursively.

    Returns void

    Note

    Warning: For deep hierarchies this creates many GPU resources upfront. Prefer ActivateTopLevelMeshes() + FracturePiece::ActivateChildMeshes() for runtime. This method is useful for editor preview or simple cases.

activateTopLevelMeshes

  • activateTopLevelMeshes(): void

  • Activates render and physics meshes for top-level pieces only.

    Returns void

    Note

    Use this for lazy activation - call on first damage to prepare only the pieces that might immediately break off. When a piece breaks, call FracturePiece::ActivateChildMeshes() to prepare the next level.

areMeshesActivated

  • areMeshesActivated(): boolean

  • Returns true if top-level meshes have been activated.

    Returns boolean

clear

  • clear(): void

  • Clears all fracture data, resetting to empty state.

    Returns void

getPiece

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods