wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUI"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/viewer/sui")
 
(18 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>}}
+
 
+
{{ScriptFunction|void|OpenQuestsWindow|()|Opens the Quests window|5=<pre>Space.UI.OpenQuestsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideQuestsWindow|()|Hides the Quests window|5=<pre>Space.UI.HideQuestsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenSettingsWindow|()|Opens the Settings window|5=<pre>Space.UI.OpenSettingsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideSettingsWindow|()|Hides the Settings window|5=<pre>Space.UI.HideSettingsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenFriendsWindow|()|Opens the Friends window|5=<pre>Space.UI.OpenFriendsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideFriendsWindow|()|Hides the Friends window|5=<pre>Space.UI.HideFriendsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenExploreWindow|()|Opens the Explore window|5=<pre>Space.UI.OpenExploreWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideExploreWindow|()|Hides the Explore window|5=<pre>Space.UI.HideExploreWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenEventsWindow|()|Opens the Events window|5=<pre>Space.UI.OpenEventsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideEventsWindow|()|Hides the Events window|5=<pre>Space.UI.HideEventsWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenHomeWindow|()|Opens the Home window|5=<pre>Space.UI.OpenHomeWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideHomeWindow|()|Hides the Home window|5=<pre>Space.UI.HideHomeWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenInventoryWindow|()|Opens the Inventory window|5=<pre>Space.UI.OpenInventoryWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideInventoryWindow|()|Hides the Inventory window|5=<pre>Space.UI.HideInventoryWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenOutfitWindow|()|Opens the Outfit window|5=<pre>Space.UI.OpenOutfitWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideOutfitWindow|()|Hides the Outfit window|5=<pre>Space.UI.HideOutfitWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenShopWindow|()|Opens the Shop window|5=<pre>Space.UI.OpenShopWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideShopWindow|()|Hides the Shop window|5=<pre>Space.UI.HideShopWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenSnapshotWindow|()|Opens the Snapshot window|5=<pre>Space.UI.OpenSnapshotWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideSnapshotWindow|()|Hides the Snapshot window|5=<pre>Space.UI.HideSnapshotWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenHelpWindow|()|Opens the Help window|5=<pre>Space.UI.OpenHelpWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideHelpWindow|()|Hides the Help window|5=<pre>Space.UI.HideHelpWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenProfileWin|()|Opens the Profile window|5=<pre>Space.UI.OpenProfileWin()</pre>}}
+
 
+
{{ScriptFunction|void|HideProfileWin|()|Hides the Profile window|5=<pre>Space.UI.HideProfileWin()</pre>}}
+
 
+
{{ScriptFunction|void|OpenUpgradeAccountWindow|()|Opens the Upgrade Account window|5=<pre>Space.UI.OpenUpgradeAccountWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideUpgradeAccountWindow|()|Hides the Upgrade Account window|5=<pre>Space.UI.HideUpgradeAccountWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenRegionInfoWindow|()|Opens the Region Info window|5=<pre>Space.UI.OpenRegionInfoWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideRegionInfoWindow|()|Hides the Region Info window|5=<pre>Space.UI.HideRegionInfoWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenExitWindow|()|Opens the Exit window|5=<pre>Space.UI.OpenExitWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideExitWindow|()|Hides the Exit window|5=<pre>Space.UI.HideExitWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenMailWindow|()|Opens the Mail window|5=<pre>Space.UI.OpenMailWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideMailWindow|()|Hides the Mail window|5=<pre>Space.UI.HideMailWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenBuyGoldWindow|()|Opens the Buy Gold window|5=<pre>Space.UI.OpenBuyGoldWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideBuyGoldWindow|()|Hides the Buy Gold window|5=<pre>Space.UI.HideBuyGoldWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenChatWindow|()|Opens the Chat window|5=<pre>Space.UI.OpenChatWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideChatWindow|()|Hides the Chat window|5=<pre>Space.UI.HideChatWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenRoomEditorWindow|()|Opens the Room Editor window|5=<pre>Space.UI.OpenRoomEditorWindow()</pre>}}
+
 
+
{{ScriptFunction|void|HideRoomEditorWindow|()|Hides the Room Editor window|5=<pre>Space.UI.HideRoomEditorWindow()</pre>}}
+
 
+
{{ScriptFunction|void|OpenDevicePicker|()|Opens the Device Picker|5=<pre>Space.UI.OpenDevicePicker()</pre>}}
+
 
+
{{ScriptFunction|SUIRaycastResult|Raycast|()|Shoots a UI Raycast and returns the result as SUIRayCastResult|5=<pre>RayCastResult= Space.UI.Raycast()</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