DartCreate
Create a new dart.
Python C++ C# VS Server
Python
BwApi.DartCreate(garmentId, dartCreationProperties)
C++
BwApiDartCreate(garmentId, dartCreationProperties);
C#
BwApi.DartCreate(garmentId, dartCreationProperties);
VS Server
{
"id": "API processing order number",
"function": "DartCreate",
"params": {
"garmentId": "value",
"dartCreationProperties": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | dartCreationProperties | JSON object as string that represents a dart object (see Schema/dart_creation_properties.json schema) |
Out | dartId | New dart ID |
Error/success code (see BwApiErrorCodes enum).
DartGet
Get a dart's properties.
Python C++ C# VS Server
Python
BwApi.DartGet(garmentId, dartId)
C++
BwApiDartGet(garmentId, dartId);
C#
BwApi.DartGet(garmentId, dartId);
VS Server
{
"id": "API processing order number",
"function": "DartGet",
"params": {
"garmentId": "value",
"dartId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | dartId | Existing dart ID |
Out | dartProperties | JSON object as string that represents a dart object (see Schema/dart_properties.json schema) |
Error/success code (see BwApiErrorCodes enum).
DartUpdate
Update a dart's properties.
Python C++ C# VS Server
Python
BwApi.DartUpdate(garmentId, dartId, dartProperties)
C++
BwApiDartUpdate(garmentId, dartId, dartProperties);
C#
BwApi.DartUpdate(garmentId, dartId, dartProperties);
VS Server
{
"id": "API processing order number",
"function": "DartUpdate",
"params": {
"garmentId": "value",
"dartId": "value",
"dartProperties": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | dartId | Existing dart ID |
In | dartProperties | JSON object as string that represents a dart object (see Schema/dart_properties.json schema) |
Error/success code (see BwApiErrorCodes enum).
DartDelete
Delete a dart but keeps the edges and stitches.
Python C++ C# VS Server
Python
BwApi.DartDelete(garmentId, dartId)
C++
BwApiDartDelete(garmentId, dartId);
C#
BwApi.DartDelete(garmentId, dartId);
VS Server
{
"id": "API processing order number",
"function": "DartDelete",
"params": {
"garmentId": "value",
"dartId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | dartId | Existing dart ID |
Error/success code (see BwApiErrorCodes enum).
DartIds
Returns a list of all darts in the given shape.
Python C++ C# VS Server
Python
BwApi.DartIds(garmentId, shapeId)
C++
BwApiDartIds(garmentId, shapeId);
C#
BwApi.DartIds(garmentId, shapeId);
VS Server
{
"id": "API processing order number",
"function": "DartIds",
"params": {
"garmentId": "value",
"shapeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | shapeId | Existing shape ID |
Out | dartIds | Array containing all the dart IDs of the shape |
Error/success code (see BwApiErrorCodes enum).