Kit groom

10 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.

Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en tools/list).

Guía

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.

Herramientas

Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de MaxAutoRisk requieren "_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumento dryRun. smoke = cubierto por edit.self_test.

groom.audit_asset (riesgo 0, UE 5.0+, requiere el plugin HairStrands, smoke)

Checks that a GroomAsset exposes inspectable data.

Argumento	Tipo	Descripción
folder	string	Content folder searched by groom.list_assets. Valor predeterminado TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Devuelve: assets, values, count.

groom.create_asset (riesgo 2, modifica, UE 5.0+, requiere el 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	Descripción
folder	string	obligatorio. Destination folder under /Game.
name	string	obligatorio. Asset name without spaces, slashes, or dots.

Devuelve: assets, values, count.

groom.get_asset (riesgo 0, UE 5.0+, requiere el plugin HairStrands, smoke)

Exports the persistent properties of a GroomAsset.

Argumento	Tipo	Descripción
folder	string	Content folder searched by groom.list_assets. Valor predeterminado TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Devuelve: assets, values, count.

groom.get_component (riesgo 0, UE 5.0+, requiere el plugin HairStrands, requiere mundo, smoke)

Returns visibility and asset bindings of one live GroomComponent.

Argumento	Tipo	Descripción
actor	string	obligatorio. Actor label that owns the GroomComponent.
component	string	obligatorio. GroomComponent object name (a GroomActor's component is GroomComponent0).

Devuelve: assets, values, count.

groom.list_assets (riesgo 0, UE 5.0+, requiere el plugin HairStrands, smoke)

Lists GroomAsset paths below a folder.

Argumento	Tipo	Descripción
folder	string	Content folder searched by groom.list_assets. Valor predeterminado TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Devuelve: assets, values, count.

groom.list_components (riesgo 0, UE 5.0+, requiere el plugin HairStrands, requiere mundo, smoke)

Lists live GroomComponents in loaded worlds.

Argumento	Tipo	Descripción
folder	string	Content folder searched by groom.list_assets. Valor predeterminado TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Devuelve: assets, values, count.

groom.list_groups (riesgo 0, UE 5.0+, requiere el plugin HairStrands, smoke)

Lists the group-related properties of a GroomAsset.

Argumento	Tipo	Descripción
folder	string	Content folder searched by groom.list_assets. Valor predeterminado TEXT("/Game").
asset	string	GroomAsset path for the asset tools.

Devuelve: assets, values, count.

groom.remove_actor (riesgo 3, modifica, destructivo, UE 5.0+, requiere el plugin HairStrands, requiere mundo, smoke)

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

Argumento	Tipo	Descripción
actor	string	obligatorio. Actor label or name; the actor must own a GroomComponent.

Devuelve: assets, values, count.

groom.set_component_visibility (riesgo 2, modifica, UE 5.0+, requiere el plugin HairStrands, requiere mundo, smoke)

Shows or hides one live GroomComponent.

Argumento	Tipo	Descripción
visible	boolean	New visibility. Valor predeterminado true.
propagate	boolean	Also apply to attached children. Valor predeterminado true.

Devuelve: assets, values, count.

groom.spawn_actor (riesgo 2, modifica, UE 5.0+, requiere el plugin HairStrands, requiere mundo, smoke)

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

Argumento	Tipo	Descripción
label	string	obligatorio. Actor label for the new GroomActor.
asset	string	Optional GroomAsset assigned to the actor's GroomComponent0.
location	{x,y,z}	World location in centimeters.

Devuelve: assets, values, count.