wiki.sine.space | sinespace

Scripting/SUI

From wiki.sine.space
Revision as of 18:11, 12 June 2021 by Voidtech (Talk | contribs)

Jump to: navigation, search

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


HideQuestsWindow

void HideQuestsWindow ()

Hides the Quests window


OpenSettingsWindow

void OpenSettingsWindow ()

Opens the Settings window


HideSettingsWindow

void HideSettingsWindow ()

Hides the Settings window


OpenFriendsWindow

void OpenFriendsWindow ()

Opens the Friends window


HideFriendsWindow

void HideFriendsWindow ()

Hides the Friends window


OpenExploreWindow

void OpenExploreWindow ()

Opens the Explore window


HideExploreWindow

void HideExploreWindow ()

Hides the Explore window


OpenEventsWindow

void OpenEventsWindow ()

Opens the Events window


HideEventsWindow

void HideEventsWindow ()

Hides the Events window


OpenHomeWindow

void OpenHomeWindow ()

Opens the Home window


HideHomeWindow

void HideHomeWindow ()

Hides the Home window


OpenInventoryWindow

void OpenInventoryWindow ()

Opens the Inventory window


HideInventoryWindow

void HideInventoryWindow ()

Hides the Inventory window


OpenOutfitWindow

void OpenOutfitWindow ()

Opens the Outfit window


HideOutfitWindow

void HideOutfitWindow ()

Hides the Outfit window


OpenShopWindow

void OpenShopWindow ()

Opens the Shop window


HideShopWindow

void HideShopWindow ()

Hides the Shop window


OpenSnapshotWindow

void OpenSnapshotWindow ()

Opens the Snapshot window


HideSnapshotWindow

void HideSnapshotWindow ()

Hides the Snapshot window


OpenHelpWindow

void OpenHelpWindow ()

Opens the Help window


HideHelpWindow

void HideHelpWindow ()

Hides the Help window


OpenProfileWin

void OpenProfileWin ()

Opens the Profile window


HideProfileWin

void HideProfileWin ()

Hides the Profile window


OpenUpgradeAccountWindow

void OpenUpgradeAccountWindow ()

Opens the Upgrade Account window


HideUpgradeAccountWindow

void HideUpgradeAccountWindow ()

Hides the Upgrade Account window


OpenRegionInfoWindow

void OpenRegionInfoWindow ()

Opens the Region Info window


HideRegionInfoWindow

void HideRegionInfoWindow ()

Hides the Region Info window


OpenExitWindow

void OpenExitWindow ()

Opens the Exit window


HideExitWindow

void HideExitWindow ()

Hides the Exit window


OpenMailWindow

void OpenMailWindow ()

Opens the Mail window


HideMailWindow

void HideMailWindow ()

Hides the Mail window


OpenBuyGoldWindow

void OpenBuyGoldWindow ()

Opens the Buy Gold window


HideBuyGoldWindow

void HideBuyGoldWindow ()

Hides the Buy Gold window


OpenChatWindow

void OpenChatWindow ()

Opens the Chat window


HideChatWindow

void HideChatWindow ()

Hides the Chat window


OpenRoomEditorWindow

void OpenRoomEditorWindow ()

Opens the Room Editor window


HideRoomEditorWindow

void HideRoomEditorWindow ()

Hides the Room Editor window


OpenDevicePicker

void OpenDevicePicker ()

Opens the Device Picker


Raycast

SUIRaycastResult Raycast ()

Shoots a UI Raycast and returns the result as SUIRayCastResult



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