set_sculpt_mask
Protect specific mesh areas from sculpt brushes and filters by setting mask strength per vertex, vertex group, or whole mesh.
Instructions
Mask part of a mesh so sculpt brushes and filters leave it alone.
1.0 is fully protected, 0.0 is free to sculpt. Works in any mode.
Args: object_name: Mesh object. value: Mask strength, 0.0 to 1.0. vertex_indices: Vertices to set; the rest keep their mask. Omit (and vertex_group) to set the whole mesh. vertex_group: Mask from a vertex group: each member gets value times its weight, other vertices are unmasked. invert: Flip the current mask (other arguments ignored). clear: Remove the mask entirely.
Returns: Dict with how many vertices are masked (above 0) and the vertex count.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"object_name": "<object_name>"
},
"name": "set_sculpt_mask"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clear | No | ||
| value | No | ||
| invert | No | ||
| object_name | Yes | ||
| vertex_group | No | ||
| vertex_indices | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||