ZipperCreate
Create a new zipper and assign it to the given elements.
Python C++ C# VS Server
Python
BwApi.ZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements)
C++
BwApiZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements);
C#
BwApi.ZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements);
VS Server
{
"id": "API processing order number",
"function": "ZipperCreate",
"params": {
"garmentId": "value",
"materialId": "value",
"leftConnectedElements": "value",
"rightConnectedElements": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | materialId | Existing material ID |
In | leftConnectedElements | Assign the left side of the zipper to this element |
In | rightConnectedElements | Assign the right side of the zipper to this element |
Out | zipperId | The ID of the new zipper |
Error/success code (see BwApiErrorCodes enum).
Zipper assignment is manual.
ZipperDelete
Delete a zipper.
Python C++ C# VS Server
Python
BwApi.ZipperDelete(garmentId, zipperId)
C++
BwApiZipperDelete(garmentId, zipperId);
C#
BwApi.ZipperDelete(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperDelete",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | The ID of the zipper to delete |
Error/success code (see BwApiErrorCodes enum).
ZipperZippedRateGet
Get the zipped percentage rate of an exiting zipper
Python C++ C# VS Server
Python
BwApi.ZipperZippedRateGet(garmentId, zipperId)
C++
BwApiZipperZippedRateGet(garmentId, zipperId);
C#
BwApi.ZipperZippedRateGet(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperZippedRateGet",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | zippedRate | The zipped rate of a zipper of value between 0 and 100 |
Error/success code (see BwApiErrorCodes enum).
ZipperZippedRateSet
Set the zipped percentage rate of an exiting zipper.
Python C++ C# VS Server
Python
BwApi.ZipperZippedRateSet(garmentId, zipperId, zippedRate)
C++
BwApiZipperZippedRateSet(garmentId, zipperId, zippedRate);
C#
BwApi.ZipperZippedRateSet(garmentId, zipperId, zippedRate);
VS Server
{
"id": "API processing order number",
"function": "ZipperZippedRateSet",
"params": {
"garmentId": "value",
"zipperId": "value",
"zippedRate": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
In | zippedRate | The zipped rate of a zipper of value between 0 and 100 |
Error/success code (see BwApiErrorCodes enum).
ZipperWidthGet
Get a zipper's width.
Python C++ C# VS Server
Python
BwApi.ZipperWidthGet(garmentId, zipperId)
C++
BwApiZipperWidthGet(garmentId, zipperId);
C#
BwApi.ZipperWidthGet(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperWidthGet",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | width | The width of a zipper in cm |
Error/success code (see BwApiErrorCodes enum).
ZipperWidthSet
Set a zipper's width.
Python C++ C# VS Server
Python
BwApi.ZipperWidthSet(garmentId, zipperId, width)
C++
BwApiZipperWidthSet(garmentId, zipperId, width);
C#
BwApi.ZipperWidthSet(garmentId, zipperId, width);
VS Server
{
"id": "API processing order number",
"function": "ZipperWidthSet",
"params": {
"garmentId": "value",
"zipperId": "value",
"width": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
In | width | The zipped rate of a zipper in cm |
Error/success code (see BwApiErrorCodes enum).
ZipperDirectionInvert
Invert a zipper's direction (zipper / puller direction).
Python C++ C# VS Server
Python
BwApi.ZipperDirectionInvert(garmentId, zipperId)
C++
BwApiZipperDirectionInvert(garmentId, zipperId);
C#
BwApi.ZipperDirectionInvert(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperDirectionInvert",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Error/success code (see BwApiErrorCodes enum).
ZipperPositionInvert
Invert a zipper's position (On which side the stopper/puller is located).
Python C++ C# VS Server
Python
BwApi.ZipperPositionInvert(garmentId, zipperId)
C++
BwApiZipperPositionInvert(garmentId, zipperId);
C#
BwApi.ZipperPositionInvert(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperPositionInvert",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Error/success code (see BwApiErrorCodes enum).
ZipperInsideGet
Check if the zipper is set to inside(0) or outside(1).
Python C++ C# VS Server
Python
BwApi.ZipperInsideGet(garmentId, zipperId)
C++
BwApiZipperInsideGet(garmentId, zipperId);
C#
BwApi.ZipperInsideGet(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperInsideGet",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | outside | Boolean (1/0) if the given zipper ID is inside or not (0-inside , 1-outside) |
Error/success code (see BwApiErrorCodes enum).
ZipperInsideSet
Set the zipper to inside(0) or outside(1).
Python C++ C# VS Server
Python
BwApi.ZipperInsideSet(garmentId, zipperId, inside)
C++
BwApiZipperInsideSet(garmentId, zipperId, inside);
C#
BwApi.ZipperInsideSet(garmentId, zipperId, inside);
VS Server
{
"id": "API processing order number",
"function": "ZipperInsideSet",
"params": {
"garmentId": "value",
"zipperId": "value",
"inside": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
In | inside | 0 - zipper is inside, 1 - zipper is outside |
Error/success code (see BwApiErrorCodes enum).
ZipperLength
Get a zipper's length.
Python C++ C# VS Server
Python
BwApi.ZipperLength(garmentId, sizeId, zipperId)
C++
BwApiZipperLength(garmentId, sizeId, zipperId);
C#
BwApi.ZipperLength(garmentId, sizeId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperLength",
"params": {
"garmentId": "value",
"sizeId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | Size of the garment |
In | zipperId | Existing zipper ID |
Out | length | The length of a zipper in cm |
Error/success code (see BwApiErrorCodes enum).
ZipperConnectedElementsSet
Set the connected elements of a zipper.
Python C++ C# VS Server
Python
BwApi.ZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements)
C++
BwApiZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements);
C#
BwApi.ZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements);
VS Server
{
"id": "API processing order number",
"function": "ZipperConnectedElementsSet",
"params": {
"garmentId": "value",
"zipperId": "value",
"leftConnectedElements": "value",
"rightConnectedElements": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
In | leftConnectedElements | The connected elements of the left side on the zipper |
In | rightConnectedElements | The connected elements of the right side on the zipper |
Error/success code (see BwApiErrorCodes enum).
ZipperConnectedElements
Get a zipper's connected elements.
Python C++ C# VS Server
Python
BwApi.ZipperConnectedElements(garmentId, zipperId)
C++
BwApiZipperConnectedElements(garmentId, zipperId);
C#
BwApi.ZipperConnectedElements(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperConnectedElements",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | leftConnectedElements | The connected elements of the left side on the zipper |
Out | rightConnectedElements | The connected elements of the right side on the zipper |
Error/success code (see BwApiErrorCodes enum).
ZipperOneEdge
Check if a zipper is one edge side or not.
Python C++ C# VS Server
Python
BwApi.ZipperOneEdge(garmentId, zipperId)
C++
BwApiZipperOneEdge(garmentId, zipperId);
C#
BwApi.ZipperOneEdge(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperOneEdge",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | oneSide | Boolean (1/0) if the given zipper ID is one edge side or not |
Error/success code (see BwApiErrorCodes enum).
ZipperMaterialIdGet
Get the group material ID assigned to the zipper.
Python C++ C# VS Server
Python
BwApi.ZipperMaterialIdGet(garmentId, zipperId)
C++
BwApiZipperMaterialIdGet(garmentId, zipperId);
C#
BwApi.ZipperMaterialIdGet(garmentId, zipperId);
VS Server
{
"id": "API processing order number",
"function": "ZipperMaterialIdGet",
"params": {
"garmentId": "value",
"zipperId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
Out | materialId | Get the assigned material ID |
Error/success code (see BwApiErrorCodes enum).
The material is from the current colorway.
ZipperMaterialIdSet
Assign a group material ID to a zipper.
Python C++ C# VS Server
Python
BwApi.ZipperMaterialIdSet(garmentId, zipperId, materialId)
C++
BwApiZipperMaterialIdSet(garmentId, zipperId, materialId);
C#
BwApi.ZipperMaterialIdSet(garmentId, zipperId, materialId);
VS Server
{
"id": "API processing order number",
"function": "ZipperMaterialIdSet",
"params": {
"garmentId": "value",
"zipperId": "value",
"materialId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | zipperId | Existing zipper ID |
In | materialId | Material ID to assign |
Error/success code (see BwApiErrorCodes enum).
The material is from the current colorway.