Kit groom

10 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia

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.

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

groom.audit_asset (risco 0, UE 5.0+, requer plugin HairStrands, smoke)

Checks that a GroomAsset exposes inspectable data.

Argumento	Tipo	Descrição
folder	string	Content folder searched by groom.list_assets. Padrão TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Retorna: assets, values, count.

groom.create_asset (risco 2, altera, UE 5.0+, requer plugin HairStrands, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination folder under /Game.
name	string	obrigatório. Asset name without spaces, slashes, or dots.

Retorna: assets, values, count.

groom.get_asset (risco 0, UE 5.0+, requer plugin HairStrands, smoke)

Exports the persistent properties of a GroomAsset.

Argumento	Tipo	Descrição
folder	string	Content folder searched by groom.list_assets. Padrão TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Retorna: assets, values, count.

groom.get_component (risco 0, UE 5.0+, requer plugin HairStrands, requer mundo, smoke)

Returns visibility and asset bindings of one live GroomComponent.

Argumento	Tipo	Descrição
actor	string	obrigatório. Actor label that owns the GroomComponent.
component	string	obrigatório. GroomComponent object name (a GroomActor's component is GroomComponent0).

Retorna: assets, values, count.

groom.list_assets (risco 0, UE 5.0+, requer plugin HairStrands, smoke)

Lists GroomAsset paths below a folder.

Argumento	Tipo	Descrição
folder	string	Content folder searched by groom.list_assets. Padrão TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Retorna: assets, values, count.

groom.list_components (risco 0, UE 5.0+, requer plugin HairStrands, requer mundo, smoke)

Lists live GroomComponents in loaded worlds.

Argumento	Tipo	Descrição
folder	string	Content folder searched by groom.list_assets. Padrão TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Retorna: assets, values, count.

groom.list_groups (risco 0, UE 5.0+, requer plugin HairStrands, smoke)

Lists the group-related properties of a GroomAsset.

Argumento	Tipo	Descrição
folder	string	Content folder searched by groom.list_assets. Padrão TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Retorna: assets, values, count.

groom.remove_actor (risco 3, altera, destrutivo, UE 5.0+, requer plugin HairStrands, requer mundo, smoke)

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

Argumento	Tipo	Descrição
actor	string	obrigatório. Actor label or name; the actor must own a GroomComponent.

Retorna: assets, values, count.

groom.set_component_visibility (risco 2, altera, UE 5.0+, requer plugin HairStrands, requer mundo, smoke)

Shows or hides one live GroomComponent.

Argumento	Tipo	Descrição
visible	boolean	New visibility. Padrão true.
propagate	boolean	Also apply to attached children. Padrão true.

Retorna: assets, values, count.

groom.spawn_actor (risco 2, altera, UE 5.0+, requer plugin HairStrands, requer mundo, smoke)

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

Argumento	Tipo	Descrição
label	string	obrigatório. Actor label for the new GroomActor.
asset	string	Optional GroomAsset assigned to the actor's GroomComponent0.
location	{x,y,z}	World location in centimeters.

Retorna: assets, values, count.