wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/SUI"

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

Revision as of 18:18, 12 June 2021

Members

OpenAppearanceEditor

void OpenAppearanceEditor ()

Opens the Appearance Editor (Outfit) 

Space.UI.OpenAppearanceEditor()


AddNotification

void AddNotification (string title, string text)

Shows a notification 

 Space.UI.AddNotification('Warning','This is a notification')


AddGlobalActionButton

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 

gbClick = function()
  Space.Log("global action button pressed")
  end
  Space.UI.AddGlobalActionButton("The Button","The Tooltip", gbClick)


ClearGlobalActionButton

void ClearGlobalActionButton (string button)

Clears a previously added Global Action Button 'button' 

 Space.UI.ClearGlobalActionButton("The Button")


ShowLocation

void ShowLocation (string reason, SVector location)

Shows given location 

 Space.UI.ShowLocation("the reason", Vector.New(5,1,0))


ShowPathToLocation

void ShowPathToLocation (string reason, SVector location)

Shows a path to given location 

 Space.UI.ShowPathToLocation("the reason", Vector.New(5,1,0))


OpenQuestsWindow

void OpenQuestsWindow ()

Opens the Quests window 

Space.UI.OpenQuestsWindow()


HideQuestsWindow

void HideQuestsWindow ()

Hides the Quests window 

Space.UI.HideQuestsWindow()


OpenSettingsWindow

void OpenSettingsWindow ()

Opens the Settings window 

Space.UI.OpenSettingsWindow()


HideSettingsWindow

void HideSettingsWindow ()

Hides the Settings window 

Space.UI.HideSettingsWindow()


OpenFriendsWindow

void OpenFriendsWindow ()

Opens the Friends window 

Space.UI.OpenFriendsWindow()


HideFriendsWindow

void HideFriendsWindow ()

Hides the Friends window 

Space.UI.HideFriendsWindow()


OpenExploreWindow

void OpenExploreWindow ()

Opens the Explore window 

Space.UI.OpenExploreWindow()


HideExploreWindow

void HideExploreWindow ()

Hides the Explore window 

Space.UI.HideExploreWindow()


OpenEventsWindow

void OpenEventsWindow ()

Opens the Events window 

Space.UI.OpenEventsWindow()


HideEventsWindow

void HideEventsWindow ()

Hides the Events window 

Space.UI.HideEventsWindow()


OpenHomeWindow

void OpenHomeWindow ()

Opens the Home window 

Space.UI.OpenHomeWindow()


HideHomeWindow

void HideHomeWindow ()

Hides the Home window 

Space.UI.HideHomeWindow()


OpenInventoryWindow

void OpenInventoryWindow ()

Opens the Inventory window 

Space.UI.OpenInventoryWindow()


HideInventoryWindow

void HideInventoryWindow ()

Hides the Inventory window 

Space.UI.HideInventoryWindow()


OpenOutfitWindow

void OpenOutfitWindow ()

Opens the Outfit window 

Space.UI.OpenOutfitWindow()


HideOutfitWindow

void HideOutfitWindow ()

Hides the Outfit window 

Space.UI.HideOutfitWindow()


OpenShopWindow

void OpenShopWindow ()

Opens the Shop window 

Space.UI.OpenShopWindow()


HideShopWindow

void HideShopWindow ()

Hides the Shop window 

Space.UI.HideShopWindow()


OpenSnapshotWindow

void OpenSnapshotWindow ()

Opens the Snapshot window 

Space.UI.OpenSnapshotWindow()


HideSnapshotWindow

void HideSnapshotWindow ()

Hides the Snapshot window 

Space.UI.HideSnapshotWindow()


OpenHelpWindow

void OpenHelpWindow ()

Opens the Help window 

Space.UI.OpenHelpWindow()


HideHelpWindow

void HideHelpWindow ()

Hides the Help window 

Space.UI.HideHelpWindow()


OpenProfileWin

void OpenProfileWin ()

Opens the Profile window 

Space.UI.OpenProfileWin()


HideProfileWin

void HideProfileWin ()

Hides the Profile window 

Space.UI.HideProfileWin()


OpenUpgradeAccountWindow

void OpenUpgradeAccountWindow ()

Opens the Upgrade Account window 

Space.UI.OpenUpgradeAccountWindow()


HideUpgradeAccountWindow

void HideUpgradeAccountWindow ()

Hides the Upgrade Account window 

Space.UI.HideUpgradeAccountWindow()


OpenRegionInfoWindow

void OpenRegionInfoWindow ()

Opens the Region Info window 

Space.UI.OpenRegionInfoWindow()


HideRegionInfoWindow

void HideRegionInfoWindow ()

Hides the Region Info window 

Space.UI.HideRegionInfoWindow()


OpenExitWindow

void OpenExitWindow ()

Opens the Exit window 

Space.UI.OpenExitWindow()


HideExitWindow

void HideExitWindow ()

Hides the Exit window 

Space.UI.HideExitWindow()


OpenMailWindow

void OpenMailWindow ()

Opens the Mail window 

Space.UI.OpenMailWindow()


HideMailWindow

void HideMailWindow ()

Hides the Mail window 

Space.UI.HideMailWindow()


OpenBuyGoldWindow

void OpenBuyGoldWindow ()

Opens the Buy Gold window 

Space.UI.OpenBuyGoldWindow()


HideBuyGoldWindow

void HideBuyGoldWindow ()

Hides the Buy Gold window 

Space.UI.HideBuyGoldWindow()


OpenChatWindow

void OpenChatWindow ()

Opens the Chat window 

Space.UI.OpenChatWindow()


HideChatWindow

void HideChatWindow ()

Hides the Chat window 

Space.UI.HideChatWindow()


OpenRoomEditorWindow

void OpenRoomEditorWindow ()

Opens the Room Editor window 

Space.UI.OpenRoomEditorWindow()


HideRoomEditorWindow

void HideRoomEditorWindow ()

Hides the Room Editor window 

Space.UI.HideRoomEditorWindow()


OpenDevicePicker

void OpenDevicePicker ()

Opens the Device Picker 

Space.UI.OpenDevicePicker()


Raycast

SUIRaycastResult Raycast ()

Shoots a UI Raycast and returns the result as SUIRayCastResult 

RayCastResult= Space.UI.Raycast()



Properties

ShowAuctionButton

bool ShowAuctionButton { get; set; }

Show the Auction button 

Space.UI.ShowAuctionButton = false


ShowChat

bool ShowChat { get; set; }

Show the Chat 

Space.UI.ShowChat = false


ShowCurrencyButton

bool ShowCurrencyButton { get; set; }

Show the Currency button 

Space.UI.ShowCurrencyButton = false


ShowExploreButton

bool ShowExploreButton { get; set; }

Show the Explore button 

Space.UI.ShowExploreButton = false


ShowFriendsButton

bool ShowFriendsButton { get; set; }

Show the Friends button 

Space.UI.ShowFriendsButton = false


ShowHelpButton

bool ShowHelpButton { get; set; }

Show the Help button 

Space.UI.ShowHelpButton = false


ShowHomeButton

bool ShowHomeButton { get; set; }

Show the Home button 

Space.UI.ShowHomeButton = false


ShowHotBar

bool ShowHotBar { get; set; }

Show the Hot Bar 

Space.UI.ShowHotBar = false


ShowInventoryButton

bool ShowInventoryButton { get; set; }

Show the Inventory button 

Space.UI.ShowInventoryButton = false


ShowMiniMap

bool ShowMiniMap { get; set; }

Set to true to show the Minimap 

Space.UI.ShowMiniMap = false


ShowOutfitButton

bool ShowOutfitButton { get; set; }

Set to true to show the Outfit button 

Space.UI.ShowOutfitButton = false


ShowQuestsButton

bool ShowQuestsButton { get; set; }

Show the Quests button 

Space.UI.ShowQuestsButton = false


ShowShopButton

bool ShowShopButton { get; set; }

Show the Shop button 

Space.UI.ShowShopButton = false


ShowSnapshotButton

bool ShowSnapshotButton { get; set; }

Show the Snapshot button 

Space.UI.ShowSnapshotButton = false


ShowUI

bool ShowUI { get; set; }

Show the User Interface 

Space.UI.ShowUI = false


v · d · e
Scripting Portal
Common
Key Classes
Helper Classes
Scripting samples and tutorials
Retrieved from "https://wiki.sine.space/index.php?title=Scripting/SUI&oldid=199629"