5.5 KiB
5.5 KiB
| name | description | metadata | ||
|---|---|---|---|---|
| probuilder-delete-faces | Delete selected faces from a `ProBuilderMesh`, creating holes or removing geometry. Supply either `faceIndices` (explicit list) or `faceDirection` (semantic selection); exactly one is required. |
|
Delete ProBuilder faces
Delete selected faces from a ProBuilderMesh, creating holes or removing geometry entirely. Faces can be selected explicitly by index or semantically by direction.
Inputs
gameObjectRef— the GameObject hosting theProBuilderMeshcomponent.faceIndices— explicit array of face indices to delete. Use 'probuilder-get-mesh-info' to discover valid indices.faceDirection— semantic alternative (Up,Down,Left,Right,Forward,Back). Exactly one offaceIndices/faceDirectionis required.
Examples
- Delete the bottom face:
faceDirection="down". - Delete specific faces:
faceIndices=[0, 2, 4].
Behavior
The mesh is rebuilt (ToMesh → Refresh), the ProBuilderMesh and GameObject are marked dirty, and Editor windows repaint. The whole call runs on the Unity main thread.
How to Call
unity-mcp-cli run-tool probuilder-delete-faces --input '{
"gameObjectRef": "string_value",
"faceIndices": "string_value",
"faceDirection": "string_value"
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool probuilder-delete-faces --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool probuilder-delete-faces --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 |
any |
Yes | Reference to the GameObject with a ProBuilderMesh component. |
faceIndices |
any |
No | Array of face indices to delete. Use this OR faceDirection, not both. Use ProBuilder_GetMeshInfo to get valid face indices. |
faceDirection |
any |
No | Semantic face selection by direction. Use this OR faceIndices, not both. |
Input JSON Schema
{
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/AIGD.GameObjectRef"
},
"faceIndices": {
"$ref": "#/$defs/System.Int32-1"
},
"faceDirection": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.FaceDirection"
}
},
"$defs": {
"UnityEngine.EntityId": {
"type": "string",
"pattern": "^[0-9]+$"
},
"System.Type": {
"type": "string"
},
"AIGD.GameObjectRef": {
"type": "object",
"properties": {
"instanceID": {
"$ref": "#/$defs/UnityEngine.EntityId",
"description": "instanceID of the UnityEngine.Object. If it is '0' and 'path', 'name', 'assetPath' and 'assetGuid' is not provided, empty or null, then it will be used as 'null'. Priority: 1 (Recommended)"
},
"path": {
"type": "string",
"description": "Path of a GameObject in the hierarchy Sample 'character/hand/finger/particle'. Priority: 2."
},
"name": {
"type": "string",
"description": "Name of a GameObject in hierarchy. Priority: 3."
},
"assetType": {
"$ref": "#/$defs/System.Type",
"description": "Type of the asset."
},
"assetPath": {
"type": "string",
"description": "Path to the asset within the project. Starts with 'Assets/'"
},
"assetGuid": {
"type": "string",
"description": "Unique identifier for the asset."
}
},
"required": [
"instanceID"
],
"description": "Find GameObject in opened Prefab or in the active Scene."
},
"System.Int32-1": {
"type": "array",
"items": {
"type": "integer"
}
},
"com.IvanMurzak.Unity.MCP.Editor.API.FaceDirection": {
"type": "string",
"enum": [
"Up",
"Down",
"Left",
"Right",
"Forward",
"Back"
]
}
},
"required": [
"gameObjectRef"
]
}
Output
Output JSON Schema
{
"type": "object",
"properties": {
"result": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.Tool_ProBuilder-DeleteFacesResponse"
}
},
"$defs": {
"System.Int32-1": {
"type": "array",
"items": {
"type": "integer"
}
},
"com.IvanMurzak.Unity.MCP.Editor.API.Tool_ProBuilder-DeleteFacesResponse": {
"type": "object",
"properties": {
"deletedFaceCount": {
"type": "integer"
},
"selectionMethod": {
"type": "string"
},
"deletedFaceIndices": {
"$ref": "#/$defs/System.Int32-1"
},
"facesRemoved": {
"type": "integer"
},
"verticesRemoved": {
"type": "integer"
},
"totalFaceCount": {
"type": "integer"
},
"totalVertexCount": {
"type": "integer"
},
"totalEdgeCount": {
"type": "integer"
}
},
"required": [
"deletedFaceCount",
"facesRemoved",
"verticesRemoved",
"totalFaceCount",
"totalVertexCount",
"totalEdgeCount"
]
}
},
"required": [
"result"
]
}