3.7 KiB
3.7 KiB
| name | description | metadata | ||
|---|---|---|---|---|
| probuilder-extrude | Extrude selected faces of a `ProBuilderMesh` along their normals, creating new geometry. Supply either `faceIndices` (explicit) or `faceDirection` (semantic); exactly one is required. Positive `distance` extrudes outward, negative inward. |
|
Extrude ProBuilder faces
Extrude selected faces of a ProBuilderMesh along their normals, creating new geometry by pushing faces outward (positive distance) or inward (negative distance). Faces can be selected explicitly by index or semantically by direction.
Inputs
gameObjectRef— the GameObject hosting theProBuilderMeshcomponent.faceIndices— explicit array of face indices to extrude.faceDirection— semantic alternative (Up,Down,Left,Right,Forward,Back). Exactly one offaceIndices/faceDirectionis required.distance— extrusion distance. Positive = outward, negative = inward. Default0.5.extrudeMethod—IndividualFaces(each face extrudes independently),FaceNormal(faces extrude as a group along the averaged normal — the default), orVertexNormal(vertices move along their normals).
Examples
- Extrude the top face up by 1 unit:
faceDirection="up",distance=1. - Extrude specific faces:
faceIndices=[0, 2, 4].
Behavior
The mesh is rebuilt (ToMesh → Refresh), dirty-flagged, and the Editor repaints. The whole call runs on the Unity main thread.
How to Call
unity-mcp-cli run-tool probuilder-extrude --input '{
"gameObjectRef": "string_value",
"faceIndices": [],
"faceDirection": "string_value",
"distance": 0,
"extrudeMethod": "string_value"
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool probuilder-extrude --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool probuilder-extrude --input-file - <<'EOF' {"param": "value"} EOF
Troubleshooting
If unity-mcp-cli is not found, either install it globally (npm install -g unity-mcp-cli) or use npx unity-mcp-cli instead.
Read the /unity-initial-setup skill for detailed installation instructions.
Input
| Name | Type | Required | Description |
|---|---|---|---|
gameObjectRef |
string |
Yes | Reference to the GameObject with a ProBuilderMesh component. RQL: GameObjectRef |
faceIndices |
array |
No | Array of face indices to extrude. Use this OR faceDirection, not both. Use ProBuilder_GetMeshInfo to get valid face indices. |
faceDirection |
string |
No | Semantic face selection by direction. Use this OR faceIndices, not both. |
distance |
number |
No | Distance to extrude the faces. Positive values extrude outward along face normals, negative values extrude inward. |
extrudeMethod |
string |
No | Extrusion method: IndividualFaces (each face extrudes independently), FaceNormal (faces extrude as a group along averaged normal), VertexNormal (vertices move along their normals). |
Input JSON Schema
{
"type": "object",
"properties": {
"gameObjectRef": {
"type": "string"
},
"faceIndices": {
"type": "array",
"items": {
"type": "integer"
}
},
"faceDirection": {
"type": "string",
"enum": [
"Up",
"Down",
"Left",
"Right",
"Forward",
"Back"
]
},
"distance": {
"type": "number"
},
"extrudeMethod": {
"type": "string",
"enum": [
"IndividualFaces",
"VertexNormal",
"FaceNormal"
]
}
},
"required": [
"gameObjectRef"
]
}
Output
This tool does not return structured output.