Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "action": "GetAvatars",                   // string
  "id": <id>,                               // string
  "avatars": ["avatar03", "AvatarBomb"]     // All available avatars (array) 
}

Get

...

Current Avatar Info (available only on next-version branch of Animaze App)

Get advanced info on a list of currently loaded avatars. The command returns a list so that it covers the Animaze Rooms scenario where there are multiple avatars spawned.

Send to Animaze

Code Block
languagejson
{
  	"action": "GetScenesGetCurrentAvatarInfo",                    	// required (string)
  	"id": <id>          "MyDevName" 					// optional (string)
}

Receive from Animaze

Code Block
languagejson
{
	"action": "GetCurrentAvatarInfo",
	"avatars": [{
		"animStandard": "AnimazeStandard_1_0",
		"description": "A spiffy and adorable red panda.",
		"friendlyName": "Fluffo",
		"isCustomized": true,
		"itemName": "avatar01_BS_Full",
		"itemType": "Avatar3D",
		"numProps": 3,
		"props": ["crown_king", "greenGlasses", "headphones"]
	}],
	"id": "MyDevName",
	"numAvatars": 1
}

Get Scenes

Get the list of ready-to-use scenes (.avatar files are already on disk).

Send to Animaze

Code Block
{
  "action": "GetScenes",                    // required (string)
  "id": <id>                                // optional (string)
}

Receive from Animaze

Code Block
{
  "action": "GetScenes",                    // string
  "id": <id>,                               // string
  "scenes": ["Spaceship", "Stream"]         // All available scenes (array) 
}

Get Current Scene Info (available only on next-version branch of Animaze App)

Get advanced info on the currently loaded scene.

Send to Animaze

Code Block
languagejson
{
	"action": "GetCurrentSceneInfo", 	// required (string)
	"id":      "MyDevName" 					// optional (string)
  "scenes}

Receive from Animaze

Code Block
languagejson
{
	"action": ["SpaceshipGetCurrentSceneInfo",
	"Streamdescription"]: "A gamer's room.",
	"friendlyName": "The RGB Room",
 // All available scenes (array) 	"id": "MyDevName",
	"itemName": "RGBRoom"
}

Get Item Icon

Get the item’s icon as base64 encoded image. This function works for all Animaze items, such as: avatars, scenes, props, emotes, voice effects, etc.

...