Clip
Load a clip.
BwApiClipLoad
Load a clip.
Python
BwApi.ClipLoad(garmentId, clipId)
C++
BwApiClipLoad(garmentId, clipId);
C#
BwApi.ClipLoad(garmentId, clipId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | clipId | Existing clip ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiClipInfoGet
Get information of a clip.
Python
BwApi.ClipInfoGet(garmentId, clipId)
C++
BwApiClipInfoGet(garmentId, clipId, info);
C#
BwApi.ClipInfoGet(garmentId, clipId);
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 clip_info.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiClipClone
Clones a clip.
Python
BwApi.ClipClone(garmentId, clipId)
C++
BwApiClipClone(garmentId, clipId);
C#
BwApi.ClipClone(garmentId, clipId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | clipId | Existing clip ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiClipDelete
Delete a clip.
Python
BwApi.ClipDelete(garmentId, clipId)
C++
BwApiClipDelete(garmentId, clipId);
C#
BwApi.ClipDelete(garmentId, clipId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | clipId | Existing clip ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiClipRename
Rename a clip.
Python
BwApi.ClipRename(garmentId, clipId, newName)
C++
BwApiClipRename(garmentId, clipId, newName);
C#
BwApi.ClipRename(garmentId, clipId, newName);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | clipId | Existing clip ID. |
In | newName | Name for the clip. |
Returns: Error/success code (see BwApiErrorCodes enum).
---