groom kit

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

Guide

Use groom.list_assets to discover project GroomAssets. groom.get_asset returns exported public property values, while groom.list_groups filters that inspection to group-related fields and groom.audit_asset reports an empty asset surface. groom.list_components lists live non-template GroomComponents in the editor process. All tools require UE5 and HairStrands.

groom.create_asset creates an empty GroomAsset through the engine Groom factory (one cards group; real strands come from an Alembic/USD import). groom.spawn_actor places a GroomActor (optionally with an asset); its component is GroomComponent0, so groom.get_component {"actor":"<label>","component":"GroomComponent0"} and groom.set_component_visibility work right away. groom.remove_actor deletes an actor that owns a GroomComponent.

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.

groom.audit_asset (risk 0, UE 5.0+, requires plugin HairStrands, smoke)

Checks that a GroomAsset exposes inspectable data.

Argument	Type	Description
folder	string	Content folder searched by groom.list_assets. Default TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Returns: assets, values, count.

groom.create_asset (risk 2, mutates, UE 5.0+, requires plugin HairStrands, smoke)

Creates an empty GroomAsset (one cards group) with the engine Groom factory; strand data normally comes from an Alembic/USD import.

Argument	Type	Description
folder	string	required. Destination folder under /Game.
name	string	required. Asset name without spaces, slashes, or dots.

Returns: assets, values, count.

groom.get_asset (risk 0, UE 5.0+, requires plugin HairStrands, smoke)

Exports the persistent properties of a GroomAsset.

Argument	Type	Description
folder	string	Content folder searched by groom.list_assets. Default TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Returns: assets, values, count.

groom.get_component (risk 0, UE 5.0+, requires plugin HairStrands, requires world, smoke)

Returns visibility and asset bindings of one live GroomComponent.

Argument	Type	Description
actor	string	required. Actor label that owns the GroomComponent.
component	string	required. GroomComponent object name (a GroomActor's component is GroomComponent0).

Returns: assets, values, count.

groom.list_assets (risk 0, UE 5.0+, requires plugin HairStrands, smoke)

Lists GroomAsset paths below a folder.

Argument	Type	Description
folder	string	Content folder searched by groom.list_assets. Default TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Returns: assets, values, count.

groom.list_components (risk 0, UE 5.0+, requires plugin HairStrands, requires world, smoke)

Lists live GroomComponents in loaded worlds.

Argument	Type	Description
folder	string	Content folder searched by groom.list_assets. Default TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Returns: assets, values, count.

groom.list_groups (risk 0, UE 5.0+, requires plugin HairStrands, smoke)

Lists the group-related properties of a GroomAsset.

Argument	Type	Description
folder	string	Content folder searched by groom.list_assets. Default TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Returns: assets, values, count.

groom.remove_actor (risk 3, mutates, destructive, UE 5.0+, requires plugin HairStrands, requires world, smoke)

Removes an actor that owns a GroomComponent (for example one spawned by groom.spawn_actor).

Argument	Type	Description
actor	string	required. Actor label or name; the actor must own a GroomComponent.

Returns: assets, values, count.

groom.set_component_visibility (risk 2, mutates, UE 5.0+, requires plugin HairStrands, requires world, smoke)

Shows or hides one live GroomComponent.

Argument	Type	Description
visible	boolean	New visibility. Default true.
propagate	boolean	Also apply to attached children. Default true.

Returns: assets, values, count.

groom.spawn_actor (risk 2, mutates, UE 5.0+, requires plugin HairStrands, requires world, smoke)

Spawns a GroomActor in the editor (or PIE) world, optionally assigning a GroomAsset.

Argument	Type	Description
label	string	required. Actor label for the new GroomActor.
asset	string	Optional GroomAsset assigned to the actor's GroomComponent0.
location	{x,y,z}	World location in centimeters.

Returns: assets, values, count.