wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUI"

From wiki.sine.space
Jump to: navigation, search
(Added, defined, and gave simple examples for all members (6) of SUI)
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/viewer/sui")
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Members=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/viewer/sui
{{ScriptFunction|void|OpenAppearanceEditor|()|Opens the Appearance Editor (Outfit)|5=<pre>Space.UI.OpenAppearanceEditor()</pre>}}
+
 
+
{{ScriptFunction|void|AddNotification|(string title, string text)|Shows a notification|5=<pre> Space.UI.AddNotification('Warning','This is a notification')</pre>}}
+
 
+
{{ScriptFunction|void|AddGlobalActionButton|(string button, string tooltip, closure action)|Adds a "Global Action Button" which is a custom button you add to the UI that calls an action of your choice then clears after being clicked|5=<pre>gbClick = function()
+
  Space.Log("global action button pressed")
+
  end
+
  Space.UI.AddGlobalActionButton("The Button","The Tooltip", gbClick)</pre>}}
+
 
+
{{ScriptFunction|void|ClearGlobalActionButton|(string button)|Clears a previously added Global Action Button 'button'|5=<pre> Space.UI.ClearGlobalActionButton("The Button")</pre>}}
+
 
+
{{ScriptFunction|void|ShowLocation|(string reason, SVector location)|Shows given location|5=<pre> Space.UI.ShowLocation("the reason", Vector.New(5,1,0))</pre>}}
+
 
+
{{ScriptFunction|void|ShowPathToLocation|(string reason, SVector location)|Shows a path to given location|5=<pre> Space.UI.ShowPathToLocation("the reason", Vector.New(5,1,0))</pre>}}
+
 
+
 
+
 
+
 
+
=Properties=
+
 
+
{{ScriptFunction|bool|ShowAuctionButton|{ get; set; }|Show the Auction button|5= <pre>Space.UI.ShowAuctionButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowChat|{ get; set; }|Show the Chat|5= <pre>Space.UI.ShowChat = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowCurrencyButton|{ get; set; }|Show the Currency button|5= <pre>Space.UI.ShowCurrencyButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowExploreButton|{ get; set; }|Show the Explore button|5= <pre>Space.UI.ShowExploreButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowFriendsButton|{ get; set; }|Show the Friends button|5= <pre>Space.UI.ShowFriendsButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowHelpButton|{ get; set; }|Show the Help button|5= <pre>Space.UI.ShowHelpButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowHomeButton|{ get; set; }|Show the Home button|5= <pre>Space.UI.ShowHomeButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowHotBar|{ get; set; }|Show the Hot Bar|5= <pre>Space.UI.ShowHotBar = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowInventoryButton|{ get; set; }|Show the Inventory button|5= <pre>Space.UI.ShowInventoryButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowMiniMap|{ get; set; }|Set to true to show the Minimap|5= <pre>Space.UI.ShowMiniMap = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowOutfitButton|{ get; set; }|Set to true to show the Outfit button|5= <pre>Space.UI.ShowOutfitButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowQuestsButton|{ get; set; }|Show the Quests button|5= <pre>Space.UI.ShowQuestsButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowShopButton|{ get; set; }|Show the Shop button|5= <pre>Space.UI.ShowShopButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowSnapshotButton|{ get; set; }|Show the Snapshot button|5= <pre>Space.UI.ShowSnapshotButton = false</pre>}}
+
 
+
{{ScriptFunction|bool|ShowUI|{ get; set; }|Show the User Interface|5= <pre>Space.UI.ShowUI = false</pre>}}
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 05:03, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/viewer/sui