Skip to main content

DiamondDart

DiamondDartCreate DiamondDartDelete DiamondDartIds ...

Updated over 2 months ago

DiamondDartCreate

Creates a new diamond dart.

Python C++ C# VS Server

Python

BwApi.DiamondDartCreate(garmentId, shapeId, path)

C++

BwApiDiamondDartCreate(garmentId, shapeId, path);

C#

BwApi.DiamondDartCreate(garmentId, shapeId, path);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartCreate",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"path": {
			"download_data": {
				"url": "URL",
				"sha256": "SHA256",
				"name": "NAME"
			}
		}
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

path

Diamond dart path (location of top point, bottom point and width of the diamond shape)

Out

diamondDartId

The newly created diamond dart ID

Error/success code (see BwApiErrorCodes enum).

DiamondDartDelete

Delete a diamond dart.

Python C++ C# VS Server

Python

BwApi.DiamondDartDelete(garmentId, shapeId, diamondDartId)

C++

BwApiDiamondDartDelete(garmentId, shapeId, diamondDartId);

C#

BwApi.DiamondDartDelete(garmentId, shapeId, diamondDartId);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartDelete",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

Error/success code (see BwApiErrorCodes enum).

DiamondDartIds

Get all the diamond dart IDs for a shape.

Python C++ C# VS Server

Python

BwApi.DiamondDartIds(garmentId, shapeId, diamondDartIds)

C++

BwApiDiamondDartIds(garmentId, shapeId, diamondDartIds);

C#

BwApi.DiamondDartIds(garmentId, shapeId, diamondDartIds);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartIds",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartIds": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartIds

Array containing all the diamond dart IDs for the given shape

Error/success code (see BwApiErrorCodes enum).

DiamondDartPathGet

Get the diamond dart's path.

Python C++ C# VS Server

Python

BwApi.DiamondDartPathGet(garmentId, shapeId, diamondDartId)

C++

BwApiDiamondDartPathGet(garmentId, shapeId, diamondDartId);

C#

BwApi.DiamondDartPathGet(garmentId, shapeId, diamondDartId);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartPathGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

Out

path

Get the path of the diamond dart (see BwApiDiamondDartPath struct)

Error/success code (see BwApiErrorCodes enum).

DiamondDartPathSet

Set the diamond dart's path.

Python C++ C# VS Server

Python

BwApi.DiamondDartPathSet(garmentId, shapeId, diamondDartId, path)

C++

BwApiDiamondDartPathSet(garmentId, shapeId, diamondDartId, path);

C#

BwApi.DiamondDartPathSet(garmentId, shapeId, diamondDartId, path);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartPathSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value",
		"path": {
			"download_data": {
				"url": "URL",
				"sha256": "SHA256",
				"name": "NAME"
			}
		}
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

In

path

Set the path of the diamond dart (see BwApiDiamondDartPath struct)

Error/success code (see BwApiErrorCodes enum).

DiamondDartStitchedGet

Get a diamond dart's stitched property.

Python C++ C# VS Server

Python

BwApi.DiamondDartStitchedGet(garmentId, shapeId, diamondDartId)

C++

BwApiDiamondDartStitchedGet(garmentId, shapeId, diamondDartId);

C#

BwApi.DiamondDartStitchedGet(garmentId, shapeId, diamondDartId);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartStitchedGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

Out

stitched

1 if stitched, 0 if not stitched

Error/success code (see BwApiErrorCodes enum).

DiamondDartStitchedSet

Set diamond dart's stitched property.

Python C++ C# VS Server

Python

BwApi.DiamondDartStitchedSet(garmentId, shapeId, diamondDartId, stitched)

C++

BwApiDiamondDartStitchedSet(garmentId, shapeId, diamondDartId, stitched);

C#

BwApi.DiamondDartStitchedSet(garmentId, shapeId, diamondDartId, stitched);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartStitchedSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value",
		"stitched": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

In

stitched

1 if stitched, 0 if not stitched

Error/success code (see BwApiErrorCodes enum).

DiamondDartMirroredIdGet

Get diamond dart's mirrored ID.

Python C++ C# VS Server

Python

BwApi.DiamondDartMirroredIdGet(garmentId, shapeId, diamondDartId)

C++

BwApiDiamondDartMirroredIdGet(garmentId, shapeId, diamondDartId);

C#

BwApi.DiamondDartMirroredIdGet(garmentId, shapeId, diamondDartId);

VS Server

{
	"id": "API processing order number",
	"function": "DiamondDartMirroredIdGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"diamondDartId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

shapeId

Existing shape ID

In

diamondDartId

Existing diamond dart ID

Out

mirroreddiamondDartId

Mirrored diamond dart ID

Error/success code (see BwApiErrorCodes enum).

This function is only relevant for inner symmetry shapes.

Did this answer your question?