unreal.DestructibleParametersFlag

class unreal.DestructibleParametersFlag

Bases: unreal.StructBase

Flags that apply to a destructible actor.

C++ Source:

  • Plugin: ApexDestruction
  • Module: ApexDestruction
  • File: DestructibleMesh.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accumulate_damage (bool): [Read-Write] If set, chunks will “remember” damage applied to them, so that many applications of a damage amount below damageThreshold will eventually fracture the chunk. If not set, a single application of damage must exceed damageThreshold in order to fracture the chunk.

  • accurate_raycasts (bool): [Read-Write] If set, the NxDestructibleActor::rayCast function will search within the nearest visible chunk hit for collisions with child chunks. This is used to get a better raycast position and normal, in case the parent collision volume does not tightly fit the graphics mesh. The returned chunk index will always be that of the visible parent that is intersected, however.

  • asset_defined_support (bool): [Read-Write] If set, then chunks which are tagged as “support” chunks (via NxDestructibleChunkDesc::isSupportChunk) will have environmental support in static destructibles.

    Note: if both bAssetDefinedSupport and bWorldSupport are set, then chunks must be tagged as “support” chunks AND overlap the Scene’s static geometry in order to be environmentally supported.

  • crumble_smallest_chunks (bool): [Read-Write] If set, the smallest chunks may be further broken down, either by fluid crumbles (if a crumble particle system is specified in the NxDestructibleActorDesc), or by simply removing the chunk if no crumble particle system is specified. Note: the “smallest chunks” are normally defined to be the deepest level of the fracture hierarchy. However, they may be taken from higher levels of the hierarchy if NxModuleDestructible::setMaxChunkDepthOffset is called with a non-zero value.

  • debris_max_separation (bool): [Read-Write] Whether or not chunks at or deeper than the “debris” depth (see NxDestructibleParameters::debrisDepth) will be removed if they separate too far from their origins. The maxSeparation is a value between NxDestructibleParameters::debrisMaxSeparationMin and NxDestructibleParameters::debrisMaxSeparationMax, based upon the destructible module’s LOD setting.

  • debris_timeout (bool): [Read-Write] Whether or not chunks at or deeper than the “debris” depth (see NxDestructibleParameters::debrisDepth) will time out. The lifetime is a value between NxDestructibleParameters::debrisLifetimeMin and NxDestructibleParameters::debrisLifetimeMax, based upon the destructible module’s LOD setting.

  • form_extended_structures (bool): [Read-Write] If initially static, the destructible will become part of an extended support structure if it is in contact with another static destructible that also has this flag set.

  • use_valid_bounds (bool): [Read-Write] If set, the ValidBounds field of NxDestructibleParameters will be used. These bounds are translated (but not scaled or rotated) to the origin of the destructible actor. If a chunk or chunk island moves outside of those bounds, it is destroyed.

  • world_support (bool): [Read-Write] If set, then chunks which overlap the Scene’s static geometry will have environmental support in static destructibles.

    Note: if both bAssetDefinedSupport and bWorldSupport are set, then chunks must be tagged as “support” chunks AND overlap the Scene’s static geometry in order to be environmentally supported.