AvatarTemplates

Get all the avatar templates in the system.

Python C++ C# VS Server

Python

BwApi.AvatarTemplates()

C++

BwApiAvatarTemplates();

C#

BwApi.AvatarTemplates();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarTemplates",
	"params": {}
}

Parameters

Param	Variable	Description
Out	templates	Avatar templates in the system

Error/success code (see BwApiErrorCodes enum).

AvatarTemplatesEx

Get all the avatar templates in the system.

Python C++ C# VS Server

Python

BwApi.AvatarTemplatesEx()

C++

BwApiAvatarTemplatesEx();

C#

BwApi.AvatarTemplatesEx();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarTemplatesEx",
	"params": {}
}

Parameters

Param	Variable	Description
Out	templates	JSON object as a string that represents an array of avatar template information (see Schema/v3.9/avatar_template.json schema)

Error/success code (see BwApiErrorCodes enum).

AvatarCreate

Create an avatar from a given template ID and select it.

Python C++ C# VS Server

Python

BwApi.AvatarCreate(avatarTemplate, name)

C++

BwApiAvatarCreate(avatarTemplate, name);

C#

BwApi.AvatarCreate(avatarTemplate, name);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarCreate",
	"params": {
		"avatarTemplate": "value",
		"name": "value"
	}
}

Parameters

Param	Variable	Description
In	avatarTemplate	Avatar template ID
In	name	Name of the avatar
Out	avatarId	ID of the avatar

Error/success code (see BwApiErrorCodes enum).

AvatarDelete

Remove an avatar.

Python C++ C# VS Server

Python

BwApi.AvatarDelete(avatarId)

C++

BwApiAvatarDelete(avatarId);

C#

BwApi.AvatarDelete(avatarId);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarDelete",
	"params": {
		"avatarId": "value"
	}
}

Parameters

Param	Variable	Description
In	avatarId	ID of an avatar

Error/success code (see BwApiErrorCodes enum).

AvatarIds

Get the avatar IDs in the system.

Python C++ C# VS Server

Python

BwApi.AvatarIds(avatarParametric)

C++

BwApiAvatarIds(avatarParametric);

C#

BwApi.AvatarIds(avatarParametric);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarIds",
	"params": {
		"avatarParametric": "value"
	}
}

Parameters

Param	Variable	Description
In	avatarParametric	Boolean (1/0) if the given avatar type is parametric or not
Out	avatarIds	IDs of the avatars

Error/success code (see BwApiErrorCodes enum).

AvatarCurrentGet

Get the current avatar ID.

Python C++ C# VS Server

Python

BwApi.AvatarCurrentGet()

C++

BwApiAvatarCurrentGet();

C#

BwApi.AvatarCurrentGet();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarCurrentGet",
	"params": {}
}

Parameters

Param	Variable	Description
Out	avatarId	ID of the avatar

Error/success code (see BwApiErrorCodes enum).

AvatarCurrentSet

Set the current avatar.

Python C++ C# VS Server

Python

BwApi.AvatarCurrentSet(avatarId)

C++

BwApiAvatarCurrentSet(avatarId);

C#

BwApi.AvatarCurrentSet(avatarId);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarCurrentSet",
	"params": {
		"avatarId": "value"
	}
}

Parameters

Param	Variable	Description
In	avatarId	ID of the avatar

Error/success code (see BwApiErrorCodes enum).

AvatarImport

Import an avatar from FBX or OBJ.

Python C++ C# VS Server

Python

BwApi.AvatarImport(path)

C++

BwApiAvatarImport(path);

C#

BwApi.AvatarImport(path);

VS Server

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

Parameters

Param	Variable	Description
In	path	Path to FBX or OBJ
Out	avatarId	ID of the avatar

Error/success code (see BwApiErrorCodes enum).

AvatarImportEx

Import an avatar from FBX or OBJ.

Python C++ C# VS Server

Python

BwApi.AvatarImportEx(jsonAvatarImport)

C++

BwApiAvatarImportEx(jsonAvatarImport);

C#

BwApi.AvatarImportEx(jsonAvatarImport);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarImportEx",
	"params": {
		"jsonAvatarImport": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarImport	JSON object as a string that represents an import properties object (see Schema/v1/avatar_import_info.json schema)
Out	avatarId	ID of the avatar

Error/success code (see BwApiErrorCodes enum).

AvatarImportVSA

Import avatars VSA.

Python C++ C# VS Server

Python

BwApi.AvatarImportVSA(path)

C++

BwApiAvatarImportVSA(path);

C#

BwApi.AvatarImportVSA(path);

VS Server

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

Parameters

Param	Variable	Description
In	path	Path to a VSA file
Out	avatarIds	Imported avatar's ID

Error/success code (see BwApiErrorCodes enum).

AvatarExportVSA

Export avatars VSA.

Python C++ C#

Python

BwApi.AvatarExportVSA(path, avatarIds)

C++

BwApiAvatarExportVSA(path, avatarIds);

C#

BwApi.AvatarExportVSA(path, avatarIds);

Parameters

Param	Variable	Description
In	path	Path to a VSA file
In	avatarIds	Exported avatar's ID

Error/success code (see BwApiErrorCodes enum).

AvatarCurrentPoseIds

Get the current avatar's pose IDs.

Python C++ C# VS Server

Python

BwApi.AvatarCurrentPoseIds()

C++

BwApiAvatarCurrentPoseIds();

C#

BwApi.AvatarCurrentPoseIds();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarCurrentPoseIds",
	"params": {}
}

Parameters

Param	Variable	Description
Out	poseIds	List of poses for the currently active avatar

Error/success code (see BwApiErrorCodes enum).

AvatarPoseCurrentGet

Get the current avatar's current pose ID.

Python C++ C# VS Server

Python

BwApi.AvatarPoseCurrentGet()

C++

BwApiAvatarPoseCurrentGet();

C#

BwApi.AvatarPoseCurrentGet();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPoseCurrentGet",
	"params": {}
}

Parameters

Param	Variable	Description
Out	poseId	Pose ID of the pose

Error/success code (see BwApiErrorCodes enum).

AvatarPoseCurrentSet

Set the current avatar's current pose.

Python C++ C# VS Server

Python

BwApi.AvatarPoseCurrentSet(poseId, redress, resimulate)

C++

BwApiAvatarPoseCurrentSet(poseId, redress, resimulate);

C#

BwApi.AvatarPoseCurrentSet(poseId, redress, resimulate);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPoseCurrentSet",
	"params": {
		"poseId": "value",
		"redress": "value",
		"resimulate": "value"
	}
}

Parameters

Param	Variable	Description
In	poseId	Pose ID of the pose
In	redress	Boolean 0 - change pose only, 1 - after changing pose redress all garments
In	resimulate	Boolean 0 - use existing snapshot if exist, 1 - create a new snapshot

Error/success code (see BwApiErrorCodes enum).

AvatarPosePropertiesGet

Get the current avatar's pose properties.

Python C++ C# VS Server

Python

BwApi.AvatarPosePropertiesGet(poseId)

C++

BwApiAvatarPosePropertiesGet(poseId);

C#

BwApi.AvatarPosePropertiesGet(poseId);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPosePropertiesGet",
	"params": {
		"poseId": "value"
	}
}

Parameters

Param	Variable	Description
In	poseId	Pose ID of the pose
Out	jsonAvatarPoseProperties	JSON object as a string that represents an avatar pose properties object (see Schema/v1/avatar_pose_properties.json schema)

Error/success code (see BwApiErrorCodes enum).

AvatarPosePropertiesUpdate

Update the current avatar's pose properties.

Python C++ C# VS Server

Python

BwApi.AvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties)

C++

BwApiAvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties);

C#

BwApi.AvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPosePropertiesUpdate",
	"params": {
		"poseId": "value",
		"jsonAvatarPoseProperties": "value"
	}
}

Parameters

Param	Variable	Description
In	poseId	Pose ID of the pose
In	jsonAvatarPoseProperties	JSON object as a string that represents an avatar pose properties object (see Schema/v1/avatar_pose_properties.json schema)

Error/success code (see BwApiErrorCodes enum).

AvatarJointIds

Get the list of joint IDs of the current avatar pose.

Python C++ C#

Python

BwApi.AvatarJointIds()

C++

BwApiAvatarJointIds();

C#

BwApi.AvatarJointIds();

Parameters

Param	Variable	Description
Out	joints	The list of avatar joint IDs

Error/success code (see BwApiErrorCodes enum).

AvatarJointPropertiesGet

Get the properties of a joint of the current avatar pose.

Python C++ C#

Python

BwApi.AvatarJointPropertiesGet(jointId)

C++

BwApiAvatarJointPropertiesGet(jointId);

C#

BwApi.AvatarJointPropertiesGet(jointId);

Parameters

Param	Variable	Description
In	jointId	The joint ID whose properties are to be retrieved
Out	jsonAvatarJointProperties	JSON object as a string that represents the properties of the given joint object (see Schema/v3.21/avatar/joint.json schema)

Error/success code (see BwApiErrorCodes enum).

AvatarJointPropertiesUpdate

Set the properties of a joint of the current avatar pose.

Python C++ C#

Python

BwApi.AvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties)

C++

BwApiAvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties);

C#

BwApi.AvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties);

Parameters

Param	Variable	Description
In	jointId	The joint ID whose rotation is to be set
In	jsonAvatarJointProperties	JSON object as a string that represents the properties of the given joint object (see Schema/v3.21/avatar/joint.json schema)

Error/success code (see BwApiErrorCodes enum).

AvatarPropertiesGet

Get the current avatar's properties. The hanging points of the avatar are according to the original avatar's axies direction except y (which is opposite)

Python C++ C# VS Server

Python

BwApi.AvatarPropertiesGet()

C++

BwApiAvatarPropertiesGet();

C#

BwApi.AvatarPropertiesGet();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPropertiesGet",
	"params": {}
}

Parameters

Param	Variable	Description
Out	jsonAvatarProperties	JSON object as a string that represents an avatar properties object (see Schema/v1/avatar_properties.json schema)

Error/success code (see BwApiErrorCodes enum).

Vertical: Direction of the object - can be one of 6: for each one of the surrounding "Cube" faces. For an avatar, could stand straight, on its head, laying parallel to us with its head to the left, head to the right, laying perpendicular to us head or feet in our direction.

Facing: each direction the objects face could turn 4 ways (like, if the object is an avatar and is in a standing pose, the face could turn front, back, left and right.

AvatarPropertiesUpdate

Update the current avatar's properties. The hanging points of the avatar are according to the original avatar's axies direction.

Python C++ C# VS Server

Python

BwApi.AvatarPropertiesUpdate(jsonAvatarProperties)

C++

BwApiAvatarPropertiesUpdate(jsonAvatarProperties);

C#

BwApi.AvatarPropertiesUpdate(jsonAvatarProperties);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarPropertiesUpdate",
	"params": {
		"jsonAvatarProperties": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarProperties	JSON object as a string that represents an avatar properties object (see Schema/v1/avatar_properties.json schema)

Error/success code (see BwApiErrorCodes enum).

The available skin tones are in <VStitcher or Lotta instalation folder>\<version>\Materials.

The available hairs are in <%applocaldata% or ~/Library/Application Support>\Browzwear\<VStitcher or Lotta instalation folder>\Avatar\HairGeoms.

Vertical: Direction of the object - can be one of 6: for each one of the surrounding "Cube" faces. For an avatar it could stand straight, on its head, laying parallel to us with its head to the left, head to the right, laying perpendicular to us with head or feet in our direction.

Facing: each direction the objects face could turn 4 ways (like, if the object is an avatar and is in a standing pose, the face could turn front, back, left and right.

The hanging points of the avatar are according to the original avatar's axies direction.

AvatarHangingPointsGet

Get the avatar's hanging points.

Python C++ C# VS Server

Python

BwApi.AvatarHangingPointsGet(jsonAvatarHangingPointsInfo)

C++

BwApiAvatarHangingPointsGet(jsonAvatarHangingPointsInfo);

C#

BwApi.AvatarHangingPointsGet(jsonAvatarHangingPointsInfo);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarHangingPointsGet",
	"params": {
		"jsonAvatarHangingPointsInfo": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarHangingPointsInfo	JSON object as a string that represents an avatar's hanging points information. (see Schema/v1/hanging_points_info.json schema)
Out	jsonAvatarHangingPoints	JSON object as a string that represents an avatar's hanging points (see Schema/v1/hanging_points.json schema)

Error/success code (see BwApiErrorCodes enum).

This function will underss the current avatar.

AvatarHangingPointsUpdate

Update the currently imported avatar's hanging points. The hanging points of the avatar are according to the original avatar's axies direction.

Python C++ C# VS Server

Python

BwApi.AvatarHangingPointsUpdate(jsonAvatarHangingPoints)

C++

BwApiAvatarHangingPointsUpdate(jsonAvatarHangingPoints);

C#

BwApi.AvatarHangingPointsUpdate(jsonAvatarHangingPoints);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarHangingPointsUpdate",
	"params": {
		"jsonAvatarHangingPoints": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarHangingPoints	JSON object as a string that represents avatar hanging points in Browzwears axies direction (see Schema/v1/hanging_points.json schema)

Error/success code (see BwApiErrorCodes enum).

Update is applicable only on imported avatars.

AvatarMeasurementsSchema

Get the current avatar's measurements schema.

Python C++ C# VS Server

Python

BwApi.AvatarMeasurementsSchema()

C++

BwApiAvatarMeasurementsSchema();

C#

BwApi.AvatarMeasurementsSchema();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarMeasurementsSchema",
	"params": {}
}

Parameters

Param	Variable	Description
Out	measurementsSchema	Schema that represents avatar measurements schema

Error/success code (see BwApiErrorCodes enum).

AvatarMeasurementsGet

Get the current avatar's measurements.

Python C++ C# VS Server

Python

BwApi.AvatarMeasurementsGet()

C++

BwApiAvatarMeasurementsGet();

C#

BwApi.AvatarMeasurementsGet();

VS Server

{
	"id": "API processing order number",
	"function": "AvatarMeasurementsGet",
	"params": {}
}

Parameters

Param	Variable	Description
Out	jsonAvatarMeasurements	JSON object as a string that represents an avatar measurements object

Error/success code (see BwApiErrorCodes enum).

AvatarMeasurementsUpdate

Update the current avatar's measurements.

Python C++ C# VS Server

Python

BwApi.AvatarMeasurementsUpdate(jsonAvatarMeasurements)

C++

BwApiAvatarMeasurementsUpdate(jsonAvatarMeasurements);

C#

BwApi.AvatarMeasurementsUpdate(jsonAvatarMeasurements);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarMeasurementsUpdate",
	"params": {
		"jsonAvatarMeasurements": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarMeasurements	JSON object as a string that represents an avatar measurements object

Error/success code (see BwApiErrorCodes enum).

The JSON jsonAvatarMeasurements will be validated with the avatar measurements schema.

AvatarMeasurementsUpdate_v2

Update the current avatar's measurements V2.

Python C++ C# VS Server

Python

BwApi.AvatarMeasurementsUpdate_v2(jsonAvatarMeasurements)

C++

BwApiAvatarMeasurementsUpdate_v2(jsonAvatarMeasurements);

C#

BwApi.AvatarMeasurementsUpdate_v2(jsonAvatarMeasurements);

VS Server

{
	"id": "API processing order number",
	"function": "AvatarMeasurementsUpdate_v2",
	"params": {
		"jsonAvatarMeasurements": "value"
	}
}

Parameters

Param	Variable	Description
In	jsonAvatarMeasurements	JSON object as a string that represents an avatar measurements object
Out	jsonMeasurementsError	JSON object as a string that represents an measurements error object (see Schema/v1/avatar_measurements_error.json schema)

Error/success code (see BwApiErrorCodes enum).

The JSON jsonAvatarMeasurements will be validated with the avatar measurements schema.