Skip to content

Commit

Permalink
Better docs for VueUI (Aurorastation#7211)
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolis2011 authored and Doxxmedearly committed Oct 26, 2019
1 parent 6bfb941 commit 61a3d0f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions vueui/README.md
Expand Up @@ -108,6 +108,10 @@ VUEUI_MONITOR_VARS(/datum/mydatum, mydatummonitor)
Asks all uis to call `object`'s `vueui_data_change` proc to make all uis up tp date. Should be used when bigger change was done or action done change that would affect global data.
### `SSvueui.get_open_uis(object)`
Gets a list of all open uis for specified object. This allows to interact with individual uis.
### `SSvueui.close_uis(obj)`
Closes all open uis for specified object.
### `SSvueui.get_open_ui(user, obj)`
Gets a singular open UI for specified user and obj combination.
### `ui.activeui`
Determines currently active view component for this ui datum. Should be combines with `check_for_change()` or `push_change()`.

Expand All @@ -128,6 +132,8 @@ Removes asset from future use in ui. But client-side asset index isn't updated i
Pushes data change to client. This also pushes changes to metadata, what includes: title, world time, ui status, active ui component, client-side asset index.
### `ui.check_for_change(forcedPush)`
Checks with `object.vueui_data_change` if data has changed, if so, then change is pushed. If forcedPush is true, then it pushes change anyways.
### `ui.resize(width, height)`
Resizes open UI to specified dimensions. Usefully when UI content changes size dramatically. Should be avoided in regular use.
### `ui.update_status()`
This call should be used if external change was detected. It checks if user still can use this ui, and what's its usability level.
### `href_list["vueui"]`
Expand Down

0 comments on commit 61a3d0f

Please sign in to comment.