AnimationSeek
Seek a cached frame.
Python C++ C# VS Server
Python
BwApi.AnimationSeek(time)
C++
BwApiAnimationSeek(time);
C#
BwApi.AnimationSeek(time);
VS Server
{
"id": "API processing order number",
"function": "AnimationSeek",
"params": {
"time": "value"
}
} Parameters
Param | Variable | Description |
In | time | Seek a cached frame |
Error/success code (see BwApiErrorCodes enum).
AnimationSettingsUpdate
Update the current animation settings.
Python C++ C# VS Server
Python
BwApi.AnimationSettingsUpdate(animationJson)
C++
BwApiAnimationSettingsUpdate(animationJson);
C#
BwApi.AnimationSettingsUpdate(animationJson);
VS Server
{
"id": "API processing order number",
"function": "AnimationSettingsUpdate",
"params": {
"animationJson": "value"
}
} Parameters
Param | Variable | Description |
In | animationJson | JSON object as string that represent an animation settings object (see Schema/animation/settings.json schema) |
Error/success code (see BwApiErrorCodes enum).
AnimationSettingsGet
Get the current animation settings.
Python C++ C# VS Server
Python
BwApi.AnimationSettingsGet()
C++
BwApiAnimationSettingsGet();
C#
BwApi.AnimationSettingsGet();
VS Server
{
"id": "API processing order number",
"function": "AnimationSettingsGet",
"params": {}
} Parameters
Param | Variable | Description |
Out | animationJson | JSON object as string that represent an animation settings object (see Schema/animation/settings.json schema) |
Error/success code (see BwApiErrorCodes enum).
AnimationPlay
Play animation preview with or without the garment.
Python C++ C# VS Server
Python
BwApi.AnimationPlay(loop)
C++
BwApiAnimationPlay(loop);
C#
BwApi.AnimationPlay(loop);
VS Server
{
"id": "API processing order number",
"function": "AnimationPlay",
"params": {
"loop": "value"
}
} Parameters
Param | Variable | Description |
In | loop | Boolean |
Error/success code (see BwApiErrorCodes enum).
The function triggers the event BW_API_EVENT_ANIMATION_READY for every cached frame.
AnimationPause
Pause the animation preview.
Python C++ C# VS Server
Python
BwApi.AnimationPause()
C++
BwApiAnimationPause();
C#
BwApi.AnimationPause();
VS Server
{
"id": "API processing order number",
"function": "AnimationPause",
"params": {}
} Error/success code (see BwApiErrorCodes enum).
AnimationExport
Export animation (mc/mdd/abc).
Python C++ C#
Python
BwApi.AnimationExport(outputFileName, presetName)
C++
BwApiAnimationExport(outputFileName, presetName);
C#
BwApi.AnimationExport(outputFileName, presetName);
Parameters
Param | Variable | Description |
In | outputFileName | File to save the export |
In | presetName | Preset file name to use (will be loaded from <BwApiSpecialFolderGet(2)>\Commons\AnimationPresets\{PRESET_MAME}.exp) |
Error/success code (see BwApiErrorCodes enum).