Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
api [2020/12/04 16:25] krysune |
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.\\ | 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 ===== | ||
Line 32: | Line 32: | ||
- | Broadcasts the state the HUD is currently in; there have been only 4 different states since inception of the HUD (InitialState, | + | 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 | Channel: -1537921546 | ||
Line 67: | Line 69: | ||
=== Queries === | === Queries === | ||
- | Queries may be performed against an individual’s HUD to procure specific information about the current/ | + | Queries may be performed against an individual’s HUD to procure specific information about the current/ |
- | * caution should be exercised in making multiple requests as attempts to abuse this will be met with permanent blocking across all HUDs | ||
< | < | ||
- | Channel: | + | Channel: |
Request: | Request: | ||
{ | { | ||
Line 103: | Line 105: | ||
=== Example Scripts: === | === Example Scripts: === | ||
- | [[https:// | + | **[[https:// |
<WRAP center round tip 60%> | <WRAP center round tip 60%> | ||
You can copy the system.main script into inventory to reveal the same information. | You can copy the system.main script into inventory to reveal the same information. |