ClipLoad
Load a clip.
Python C++ C# VS Server
Python
BwApi.ClipLoad(garmentId, clipId)
C++
BwApiClipLoad(garmentId, clipId);
C#
BwApi.ClipLoad(garmentId, clipId);
VS Server
{
"id": "API processing order number",
"function": "ClipLoad",
"params": {
"garmentId": "value",
"clipId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | clipId | Existing clip ID |
Error/success code (see BwApiErrorCodes enum).
ClipInfoGet
Get information of a clip.
Python C++ C# VS Server
Python
BwApi.ClipInfoGet(garmentId, clipId)
C++
BwApiClipInfoGet(garmentId, clipId);
C#
BwApi.ClipInfoGet(garmentId, clipId);
VS Server
{
"id": "API processing order number",
"function": "ClipInfoGet",
"params": {
"garmentId": "value",
"clipId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | clipId | Existing clip ID |
Out | info | JSON object as a string that represents the clip (see Schema/clip_info.json schema) |
Error/success code (see BwApiErrorCodes enum).
ClipClone
Clones a clip.
Python C++ C# VS Server
Python
BwApi.ClipClone(garmentId, clipId)
C++
BwApiClipClone(garmentId, clipId);
C#
BwApi.ClipClone(garmentId, clipId);
VS Server
{
"id": "API processing order number",
"function": "ClipClone",
"params": {
"garmentId": "value",
"clipId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | clipId | Existing clip ID |
Error/success code (see BwApiErrorCodes enum).
ClipDelete
Delete a clip.
Python C++ C# VS Server
Python
BwApi.ClipDelete(garmentId, clipId)
C++
BwApiClipDelete(garmentId, clipId);
C#
BwApi.ClipDelete(garmentId, clipId);
VS Server
{
"id": "API processing order number",
"function": "ClipDelete",
"params": {
"garmentId": "value",
"clipId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | clipId | Existing clip ID |
Error/success code (see BwApiErrorCodes enum).
ClipRename
Rename a clip.
Python C++ C# VS Server
Python
BwApi.ClipRename(garmentId, clipId, newName)
C++
BwApiClipRename(garmentId, clipId, newName);
C#
BwApi.ClipRename(garmentId, clipId, newName);
VS Server
{
"id": "API processing order number",
"function": "ClipRename",
"params": {
"garmentId": "value",
"clipId": "value",
"newName": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | clipId | Existing clip ID |
In | newName | Name for the clip |
Error/success code (see BwApiErrorCodes enum).