Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api [2020/12/04 15:41] krysune created |
api [2021/12/14 04:38] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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 ===== | ||
| + | |||
| + | 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. | ||
| + | |||
| + | ==== Stats ==== | ||
| + | |||
| + | 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 | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | ==== State ==== | ||
| + | |||
| + | |||
| + | Broadcasts the state the HUD is currently in; there have been only 4 different states since inception of the HUD (InitialState, | ||
| + | * 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 | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | |||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | ==== Pregnancy ==== | ||
| + | |||
| + | |||
| + | 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 | ||
| + | { | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | === Queries === | ||
| + | |||
| + | Queries may be performed against an individual’s HUD to procure specific information about the current/ | ||
| + | |||
| + | |||
| + | < | ||
| + | Channel: TBD | ||
| + | Request: | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | ] | ||
| + | } | ||
| + | </ | ||
| + | Response: | ||
| + | < | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Example Scripts: === | ||
| + | |||
| + | **[[https:// | ||
| + | <WRAP center round tip 60%> | ||
| + | You can copy the system.main script into inventory to reveal the same information. | ||
| + | </ | ||
| + | |||