7.8 KiB
7.8 KiB
| name | description | metadata | ||
|---|---|---|---|---|
| splines-evaluate | Evaluate a spline at normalized parameter `t` in [0,1], returning the local-space and world-space position, the tangent (direction of travel), and the up vector. Read-only. |
|
Splines / Evaluate
Sample a spline at a point along its length. t is normalized: 0 is the first knot, 1 is the last knot (or the loop point for a closed spline).
Inputs
gameObjectRef— the GameObject hosting theSplineContainer(required).t— normalized parameter in [0,1] (default 0.5). Values outside are clamped.splineIndex— which spline in the container (default 0).
Behavior
Evaluates local position / tangent / up via Spline.Evaluate, transforms the position into world space using the container's transform, and returns all of them. The spline must have at least 2 knots. Read-only. Runs on the Unity main thread.
How to Call
unity-mcp-cli run-tool splines-evaluate --input '{
"gameObjectRef": "string_value",
"t": 0,
"splineIndex": 0
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool splines-evaluate --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool splines-evaluate --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 containing the SplineContainer component. |
t |
number |
No | Normalized parameter along the spline in [0,1] (clamped). Default 0.5. |
splineIndex |
integer |
No | Index of the spline inside the container (default 0). |
Input JSON Schema
{
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/AIGD.GameObjectRef"
},
"t": {
"type": "number"
},
"splineIndex": {
"type": "integer"
}
},
"$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."
}
},
"required": [
"gameObjectRef"
]
}
Output
Output JSON Schema
{
"type": "object",
"properties": {
"result": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.Tool_Splines-EvaluateResponse"
}
},
"$defs": {
"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."
},
"UnityEngine.EntityId": {
"type": "string",
"pattern": "^[0-9]+$"
},
"System.Type": {
"type": "string"
},
"AIGD.ComponentRef": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"description": "Component 'index' attached to a gameObject. The first index is '0' and that is usually Transform or RectTransform. Priority: 2. Default value is -1."
},
"typeName": {
"type": "string",
"description": "Component type full name. Sample 'UnityEngine.Transform'. If the gameObject has two components of the same type, the output component is unpredictable. Priority: 3. Default value is null."
},
"instanceID": {
"$ref": "#/$defs/UnityEngine.EntityId",
"description": "instanceID of the UnityEngine.Object. If this is '0', then it will be used as 'null'."
}
},
"required": [
"index",
"instanceID"
],
"description": "Component reference. Used to find a Component at GameObject."
},
"UnityEngine.Vector3": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"additionalProperties": false
},
"com.IvanMurzak.Unity.MCP.Editor.API.Tool_Splines-EvaluateResponse": {
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/AIGD.GameObjectRef",
"description": "Reference to the SplineContainer GameObject."
},
"containerRef": {
"$ref": "#/$defs/AIGD.ComponentRef",
"description": "Reference to the SplineContainer component."
},
"splineIndex": {
"type": "integer",
"description": "Index of the evaluated spline in the container."
},
"t": {
"type": "number",
"description": "Normalized parameter actually evaluated (after clamping)."
},
"localPosition": {
"$ref": "#/$defs/UnityEngine.Vector3",
"description": "Local-space position at t."
},
"worldPosition": {
"$ref": "#/$defs/UnityEngine.Vector3",
"description": "World-space position at t."
},
"tangent": {
"$ref": "#/$defs/UnityEngine.Vector3",
"description": "Tangent (direction of travel) at t."
},
"up": {
"$ref": "#/$defs/UnityEngine.Vector3",
"description": "Up vector at t."
}
},
"required": [
"splineIndex",
"t",
"localPosition",
"worldPosition",
"tangent",
"up"
]
}
},
"required": [
"result"
]
}