Outfit
This file contains outfit functionality, you can get outfit state objects and create new outfit.
BwApiOutfitCreate
Creates a new empty garment.
Python
BwApi.OutfitCreate(outfitProperties)
C++
BwApiOutfitCreate(outfitProperties, garmentIDOut);
C#
BwApi.OutfitCreate(outfitProperties);
Parameters
Param | Variable | Description |
In | outfitProperties | The properties json for creating new outfit (see create_outfit.json schema). |
Out | garmentIDOut | The created garment ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiOutfitReadGarmentProperties
Partially reads the garment file at path and returns the garment info for oufit state usage.
Python
BwApi.OutfitReadGarmentProperties(path)
C++
BwApiOutfitReadGarmentProperties(path, garmentPropertiesOut);
C#
BwApi.OutfitReadGarmentProperties(path);
Parameters
Param | Variable | Description |
In | path | Full path to the garment file. |
Out | garmentPropertiesOut | The garment json for outfit state object usage. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiOutfitGet
Python
BwApi.OutfitGet(garmentId)
C++
BwApiOutfitGet(garmentId, isOutfit);
C#
BwApi.OutfitGet(garmentId);
Parameters
Param | Variable | Description |
In | garmentId | The garment ID. |
Out | isOutfit | 1 if the garment is a outfit, 0 otherwise. |
Returns: Error/success code (see BwApiErrorCodes enum).
---