Developers API

Though great efforts will be made to keep items backwards compatible; it is advised that developers should make scripts easily upgradable to accommodate changes.

Broadcasts are usually handled on five minute intervals; some may occur more frequently and are in the form of JSON objects. It would be prudent to retrieve these values under scripts that have ample free space as broadcast message sizes can increase over time with additional information.

Broadcasts internal and external stats as decimal percent values (quantity values may be acquired via the query), and includes additional flags that do not have numeric representation. Some values may exceed 1.000 (100%) such as the physical abdomen attribute which may extend beyond 1.000 depending on what the character may be holding inside, such as a pregnancy for example.

Channel: -1537921545
  {
   "stats":{
      "internal":{
         "vitality":"1.000",
         "strength":"1.000",
         "defense":"1.000",
         "conscious":"1.000",
         "arousal":"0.000",
         "essence":"1.000"
      },
      "physical":{
         "abdomen":"0.000"
      },
      "flags":{
         "fertile":false
      }
   }
}

Broadcasts the state the HUD is currently in; there have been only 4 different states since inception of the HUD (InitialState, RunningState, CopulateState, BirthingState). Each state may add additional information that might be of particular interest; as example:

• CopulateState provides the target which is being copulated with and the story (which is the actively selected option such as “Breeding” that may also add additional relevant output).
  
• Top-level will always have a key that matches the value of “state” (notice in the example state equals “CopulateState” which is the key for the object that holds the target and story entries)

Channel: -1537921546
{
   "state":"CopulateState",
   "CopulateState":{
      "target":"56ada134-2464-47dc-8644-c8e57571205e",
      "story":{

      }
   }
}

Broadcasts internals about any pregnancies an individual may have, including how many births of what species from where and about how far along the pregnancy is completed represented as a percent.

Channel: -1537921547
{
   "pregnancies":[
      {
         "embryos":4,
         "species":"Fennec",
         "incubator":"Uterus",
         "gestation":0.732
      }
   ],
   "flags":{
      "pregnant":true
   }
}

Queries may be performed against an individual’s HUD to procure specific information about the current/active profile. Requests and responses are handled on the same channel and as such, is important to only make use of llRegionSayTo when making a request, as the response will also be doing the same. Request format may change but will at minimum always require a handle and query values; the handle is returned back in the response for the developers own request/response tracking. Request options are limited at this time; if looking for something specific, reach out to the developer Feral Ninetails in world.

Channel: TBD
Request:
{
   "handle":"NONCE",
   "query":"character",
   "elements":[
      "profile",
      "species"
   ]
}

Response:

{
   "handle":"NONCE",
   "success":true,
   "result":{
      "profile":{
         "fullName":"NueFox",
         "classType":"Demon",
         "formType":"Anthro",
         "genderType":"Male"
      },
      "species":{
         "name":"Fennec"
      }
   }
}

AnE Stats HUD Script