Skip to main content

`chaos` kit

25 tools. Generated from the plugin source; do not edit by hand.

Guide

Use this kit with UE5 and the experimental Geometry Collection plugin enabled.

Create a collection. sourceMesh (UE 5.1+) converts a static mesh into the collection: chaos.create_collection {"folder":"/Game/Destruction","name":"GC_Crate","sourceMesh":"/Game/Props/SM_Crate"}. Without it the collection is empty.
chaos.inspect_collection and chaos.list_collection_properties show the reflected settings.
Change one setting at a time with chaos.set_collection_property (or the collision, damage and clustering variants), using names returned by the list call, e.g. EnableClustering, Mass.
Run the audits (chaos.audit_collection, materials, size-specific data).
Place it: chaos.spawn_collection_actor {"asset":"/Game/Destruction/GC_Crate","label":"Crate"}.
Inspect and edit the component by actor label (chaos.inspect_component, chaos.list_component_properties, chaos.set_component_property with e.g. bNotifyBreaks).
Remove test actors with chaos.delete_collection_actors {"actors":["Crate"]}.

Fracturing itself (Voronoi, slicing, cluster surgery) lives in Fracture-mode commands that Unreal keeps private; they are not scriptable here. Cache recording and field-driven damage need a PIE-safe asynchronous owner and are intentionally not exposed by this synchronous kit.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

`chaos.audit_collection` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.audit_component` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Actor label or name.
`component`	string	Optional component name.

Returns: target, values, message, count.

`chaos.create_collection` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`folder`	string	required. Destination content folder.
`name`	string	required. Bare asset name.
`sourceMesh`	string	Optional StaticMesh to convert into the collection (UE 5.1+), for example /Engine/BasicShapes/Cube; empty creates an empty collection.

Returns: target, values, message, count.

`chaos.delete_collection_actors` (risk 3, mutates, destructive, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

Deletes editor-world actors that own a Geometry Collection component.

Argument	Type	Description
`actors`	array of string	required. Labels/names of editor-world actors that own a Geometry Collection component.

Returns: target, values, message, count.

`chaos.get_cache_settings` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Actor label or name.
`component`	string	Optional component name.

Returns: target, values, message, count.

`chaos.get_clustering_settings` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.get_collection_property` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected editable property name.
`value`	string	Unreal text value for the property.

Returns: target, values, message, count.

`chaos.get_collision_settings` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.get_component_property` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected component property name.
`value`	string	Unreal text value for mutations.

Returns: target, values, message, count.

`chaos.get_damage_settings` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.get_fracture_settings` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.get_materials` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.get_runtime_state` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Actor label or name.
`component`	string	Optional component name.

Returns: target, values, message, count.

`chaos.get_size_specific_data` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.inspect_collection` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.inspect_component` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Actor label or name.
`component`	string	Optional component name.

Returns: target, values, message, count.

`chaos.list_collection_properties` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.

Returns: target, values, message, count.

`chaos.list_component_properties` (risk 0, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Actor label or name.
`component`	string	Optional component name.

Returns: target, values, message, count.

`chaos.set_cache_setting` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected component property name.
`value`	string	Unreal text value for mutations.

Returns: target, values, message, count.

`chaos.set_clustering_setting` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected editable property name.
`value`	string	Unreal text value for the property.

Returns: target, values, message, count.

`chaos.set_collection_property` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected editable property name.
`value`	string	Unreal text value for the property.

Returns: target, values, message, count.

`chaos.set_collision_setting` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected editable property name.
`value`	string	Unreal text value for the property.

Returns: target, values, message, count.

`chaos.set_component_property` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected component property name.
`value`	string	Unreal text value for mutations.

Returns: target, values, message, count.

`chaos.set_damage_setting` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, smoke)

No description.

Argument	Type	Description
`property`	string	required. Reflected editable property name.
`value`	string	Unreal text value for the property.

Returns: target, values, message, count.

`chaos.spawn_collection_actor` (risk 2, mutates, UE 5.1+, requires plugin GeometryCollectionPlugin, requires world, smoke)

Spawns a GeometryCollectionActor in the editor world using a Geometry Collection asset (e.g. one made by chaos.create_collection with sourceMesh).

Argument	Type	Description
`asset`	string	required. Geometry Collection asset path.
`label`	string	required. Actor label for the new GeometryCollectionActor.
`location`	{x,y,z}	World location in centimetres.

Returns: target, values, message, count.

Guide
Tools