Inheritance diagram for SineSpace.Scripting.Client.SUI:

Public Member Functions
override void	Initialise (SScript runtime, object wrapper)

void	AddNotification (string title, string text)

void	OpenAppearanceEditor ()

void	ShowPathToLocation (string reason, SVector location)

void	ShowLocation (string reason, SVector location)

void	AddGlobalActionButton (string button, string tooltip, Closure action)

void	ClearGlobalActionButton (string button)

void	OpenQuestsWindow ()
	Opens the Quests window. (white-label grid only) More...

void	HideQuestsWindow ()
	Hides the Quests window. (white-label grid only) More...

void	OpenSettingsWindow ()
	Opens the Settings window. (white-label grid only) More...

void	HideSettingsWindow ()
	Hides the Settings window. (white-label grid only) More...

void	OpenFriendsWindow ()

void	HideFriendsWindow ()

void	OpenExploreWindow ()

void	HideExploreWindow ()

void	OpenEventsWindow ()

void	HideEventsWindow ()

void	OpenHomeWindow ()

void	HideHomeWindow ()

void	OpenInventoryWindow ()

void	HideInventoryWindow ()

void	OpenOutfitWindow ()

void	HideOutfitWindow ()

void	OpenShopWindow ()

void	HideShopWindow ()

void	OpenSnapshotWindow ()

void	HideSnapshotWindow ()

void	OpenHelpWindow ()

void	HideHelpWindow ()

void	OpenProfileWin ()

void	HideProfileWindow ()

void	OpenUpgradeAccountWindow ()

void	HideUpgradeAccountWindow ()

void	OpenRegionInfoWindow ()

void	HideRegionInfoWindow ()

void	OpenExitWindow ()

void	HideExitWindow ()

void	OpenMailWindow ()

void	HideMailWindow ()

void	OpenFeedbackWindow ()

void	HideFeedbackWindow ()

void	OpenBuyGoldWindow ()

void	HideBuyGoldWindow ()

void	OpenChatWindow ()

void	HideChatWindow ()

void	OpenRoomEditorWindow ()

void	HideRoomEditorWindow ()

void	OpenDevicePicker ()

void	OpenDeviceTester ()

SUIRaycastResult	Raycast ()

Public Member Functions inherited from ScriptClass< T >
void	ReportError (string error, bool fatal, UnityEngine.Object target=null)

Public Member Functions inherited from ScriptClassWrapper< T >
override void	Initialise (SScript runtime, object wrapper)

Properties
bool	ShowUI `[get, set]`

bool	ShowWorldUI `[get, set]`

int	MusicVolume `[get, set]`

int	MasterVolume `[get, set]`

int	SFXVolume `[get, set]`

int	UIVolume `[get, set]`

int	VOIPVolume `[get, set]`

bool	ShowFriendsButton `[get, set]`
	Show the Friends button. (white-label grid only) More...

bool	ShowExploreButton `[get, set]`
	Show the Explore button. (white-label grid only) More...

bool	ShowQuestsButton `[get, set]`

bool	ShowInventoryButton `[get, set]`

bool	ShowOutfitButton `[get, set]`

bool	ShowShopButton `[get, set]`

bool	ShowAuctionButton `[get, set]`
	Show the Auction button. (white-label grid only) More...

bool	ShowSnapshotButton `[get, set]`

bool	ShowHelpButton `[get, set]`
	Show the Help button. (white-label grid only) More...

bool	ShowCurrencyButton `[get, set]`

bool	ShowGoldAndBuyButton `[get, set]`

bool	ShowChat `[get, set]`
	Show the Chat. (white-label grid only) More...

bool	ShowMiniMap `[get, set]`

bool	ShowHotBar `[get, set]`
	Show the Hot Bar. (white-label grid only) More...

bool	ShowEventsButton `[get, set]`

bool	ShowHomeButton `[get, set]`
	Show the Home button. (white-label grid only) More...

bool	ShowActivityPanel `[get, set]`

bool	ShowProfileImage `[get, set]`

bool	ShowRightButtonGroup `[get, set]`

bool	ShowRoomInfoOption `[get, set]`

bool	ShowSearch `[get, set]`

bool	ShowMailButton `[get, set]`

bool	ShowNotificationButton `[get, set]`
	Show the Notification button. (white-label grid only) More...

bool	ShowClock `[get, set]`

Properties inherited from ScriptClass< T >
override bool	Alive `[get]`
	Return if the component is alive. More...

virtual bool	Alive `[get]`

DynValue	CachedData `[get, set]`

Properties inherited from ScriptClassWrapper< T >
T	_wrap `[get]`

Additional Inherited Members
Protected Member Functions inherited from ScriptClass< T >
void	Initialise (SScript runtime)

Member Function Documentation

◆ AddGlobalActionButton()

void SineSpace.Scripting.Client.SUI.AddGlobalActionButton	(	string	button,
		string	tooltip,
		Closure	action
	)

◆ AddNotification()

void SineSpace.Scripting.Client.SUI.AddNotification	(	string	title,
		string	text
	)

◆ ClearGlobalActionButton()

void SineSpace.Scripting.Client.SUI.ClearGlobalActionButton ( string button )

◆ HideBuyGoldWindow()

void SineSpace.Scripting.Client.SUI.HideBuyGoldWindow ( )

◆ HideChatWindow()

void SineSpace.Scripting.Client.SUI.HideChatWindow ( )

◆ HideEventsWindow()

void SineSpace.Scripting.Client.SUI.HideEventsWindow ( )

◆ HideExitWindow()

void SineSpace.Scripting.Client.SUI.HideExitWindow ( )

◆ HideExploreWindow()

void SineSpace.Scripting.Client.SUI.HideExploreWindow ( )

◆ HideFeedbackWindow()

void SineSpace.Scripting.Client.SUI.HideFeedbackWindow ( )

◆ HideFriendsWindow()

void SineSpace.Scripting.Client.SUI.HideFriendsWindow ( )

◆ HideHelpWindow()

void SineSpace.Scripting.Client.SUI.HideHelpWindow ( )

◆ HideHomeWindow()

void SineSpace.Scripting.Client.SUI.HideHomeWindow ( )

◆ HideInventoryWindow()

void SineSpace.Scripting.Client.SUI.HideInventoryWindow ( )

◆ HideMailWindow()

void SineSpace.Scripting.Client.SUI.HideMailWindow ( )

◆ HideOutfitWindow()

void SineSpace.Scripting.Client.SUI.HideOutfitWindow ( )

◆ HideProfileWindow()

void SineSpace.Scripting.Client.SUI.HideProfileWindow ( )

◆ HideQuestsWindow()

void SineSpace.Scripting.Client.SUI.HideQuestsWindow ( )

Hides the Quests window. (white-label grid only)

&ndash;This script will make a button show/hide the Quests Window
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add a UI Button as a reference in the Scripting Runtime Component]
 
theButton  = Space.Host.GetReference('TheButton')
    local isShown = false
 
OnClick = function()
    if isShown then
Space.UI.HideQuestsWindow()
    isShown = false
        else
Space.UI.OpenQuestsWindow()  
<br>
    isShown = true
end
    end
 
theButton.UIButton.OnClick(OnClick) 

◆ HideRegionInfoWindow()

void SineSpace.Scripting.Client.SUI.HideRegionInfoWindow ( )

◆ HideRoomEditorWindow()

void SineSpace.Scripting.Client.SUI.HideRoomEditorWindow ( )

◆ HideSettingsWindow()

void SineSpace.Scripting.Client.SUI.HideSettingsWindow ( )

Hides the Settings window. (white-label grid only)

&ndash;This script will make a button show/hide the Settings Window
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add a UI Button as a reference in the Scripting Runtime Component]
 
theButton  = Space.Host.GetReference('TheButton')
    local isShown = false
 
OnClick = function()
    if isShown then
Space.UI.HideSettingsWindow()
    isShown = false
        else
Space.UI.OpenSettingsWindow()  
<br>
    isShown = true
end
    end
 
theButton.UIButton.OnClick(OnClick) 

◆ HideShopWindow()

void SineSpace.Scripting.Client.SUI.HideShopWindow ( )

◆ HideSnapshotWindow()

void SineSpace.Scripting.Client.SUI.HideSnapshotWindow ( )

◆ HideUpgradeAccountWindow()

void SineSpace.Scripting.Client.SUI.HideUpgradeAccountWindow ( )

◆ Initialise()

override void SineSpace.Scripting.Client.SUI.Initialise	(	SScript	runtime,
		object	wrapper
	)

virtual

Implements ScriptClass< T >.

◆ OpenAppearanceEditor()

void SineSpace.Scripting.Client.SUI.OpenAppearanceEditor ( )

◆ OpenBuyGoldWindow()

void SineSpace.Scripting.Client.SUI.OpenBuyGoldWindow ( )

◆ OpenChatWindow()

void SineSpace.Scripting.Client.SUI.OpenChatWindow ( )

◆ OpenDevicePicker()

void SineSpace.Scripting.Client.SUI.OpenDevicePicker ( )

◆ OpenDeviceTester()

void SineSpace.Scripting.Client.SUI.OpenDeviceTester ( )

◆ OpenEventsWindow()

void SineSpace.Scripting.Client.SUI.OpenEventsWindow ( )

◆ OpenExitWindow()

void SineSpace.Scripting.Client.SUI.OpenExitWindow ( )

◆ OpenExploreWindow()

void SineSpace.Scripting.Client.SUI.OpenExploreWindow ( )

◆ OpenFeedbackWindow()

void SineSpace.Scripting.Client.SUI.OpenFeedbackWindow ( )

◆ OpenFriendsWindow()

void SineSpace.Scripting.Client.SUI.OpenFriendsWindow ( )

◆ OpenHelpWindow()

void SineSpace.Scripting.Client.SUI.OpenHelpWindow ( )

◆ OpenHomeWindow()

void SineSpace.Scripting.Client.SUI.OpenHomeWindow ( )

◆ OpenInventoryWindow()

void SineSpace.Scripting.Client.SUI.OpenInventoryWindow ( )

◆ OpenMailWindow()

void SineSpace.Scripting.Client.SUI.OpenMailWindow ( )

◆ OpenOutfitWindow()

void SineSpace.Scripting.Client.SUI.OpenOutfitWindow ( )

◆ OpenProfileWin()

void SineSpace.Scripting.Client.SUI.OpenProfileWin ( )

◆ OpenQuestsWindow()

void SineSpace.Scripting.Client.SUI.OpenQuestsWindow ( )

Opens the Quests window. (white-label grid only)

&ndash;This script will make a button show/hide the Quests Window
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add a UI Button as a reference in the Scripting Runtime Component]
 
theButton  = Space.Host.GetReference('TheButton')
    local isShown = false
 
OnClick = function()
    if isShown then
Space.UI.HideQuestsWindow()
    isShown = false
        else
Space.UI.OpenQuestsWindow()  
<br>
    isShown = true
end
    end
 
theButton.UIButton.OnClick(OnClick) 

◆ OpenRegionInfoWindow()

void SineSpace.Scripting.Client.SUI.OpenRegionInfoWindow ( )

◆ OpenRoomEditorWindow()

void SineSpace.Scripting.Client.SUI.OpenRoomEditorWindow ( )

◆ OpenSettingsWindow()

void SineSpace.Scripting.Client.SUI.OpenSettingsWindow ( )

Opens the Settings window. (white-label grid only)

&ndash;This script will make a button show/hide the Settings Window
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add a UI Button as a reference in the Scripting Runtime Component]
 
theButton  = Space.Host.GetReference('TheButton')
    local isShown = false
 
OnClick = function()
    if isShown then
Space.UI.HideSettingsWindow()
    isShown = false
        else
Space.UI.OpenSettingsWindow()  
<br>
    isShown = true
end
    end
 
theButton.UIButton.OnClick(OnClick) 

◆ OpenShopWindow()

void SineSpace.Scripting.Client.SUI.OpenShopWindow ( )

◆ OpenSnapshotWindow()

void SineSpace.Scripting.Client.SUI.OpenSnapshotWindow ( )

◆ OpenUpgradeAccountWindow()

void SineSpace.Scripting.Client.SUI.OpenUpgradeAccountWindow ( )

◆ Raycast()

SUIRaycastResult SineSpace.Scripting.Client.SUI.Raycast ( )

◆ ShowLocation()

void SineSpace.Scripting.Client.SUI.ShowLocation	(	string	reason,
		SVector	location
	)

◆ ShowPathToLocation()

void SineSpace.Scripting.Client.SUI.ShowPathToLocation	(	string	reason,
		SVector	location
	)

Property Documentation

◆ MasterVolume

int SineSpace.Scripting.Client.SUI.MasterVolume

getset

◆ MusicVolume

int SineSpace.Scripting.Client.SUI.MusicVolume

getset

◆ SFXVolume

int SineSpace.Scripting.Client.SUI.SFXVolume

getset

◆ ShowActivityPanel

bool SineSpace.Scripting.Client.SUI.ShowActivityPanel

getset

◆ ShowAuctionButton

bool SineSpace.Scripting.Client.SUI.ShowAuctionButton

getset

Show the Auction button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Auction Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowAuctionButton = true
    else
        Space.UI.ShowAuctionButton = false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowChat

bool SineSpace.Scripting.Client.SUI.ShowChat

getset

Show the Chat. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Chat
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowChat= true
    else
        Space.UI.ShowChat= false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowClock

bool SineSpace.Scripting.Client.SUI.ShowClock

getset

◆ ShowCurrencyButton

bool SineSpace.Scripting.Client.SUI.ShowCurrencyButton

getset

◆ ShowEventsButton

bool SineSpace.Scripting.Client.SUI.ShowEventsButton

getset

◆ ShowExploreButton

bool SineSpace.Scripting.Client.SUI.ShowExploreButton

getset

Show the Explore button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Explore Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowExploreButton = true
    else
        Space.UI.ShowExploreButton = false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowFriendsButton

bool SineSpace.Scripting.Client.SUI.ShowFriendsButton

getset

Show the Friends button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Friends Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowFriendsButton = true
    else
        Space.UI.ShowFriendsButton = false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowGoldAndBuyButton

bool SineSpace.Scripting.Client.SUI.ShowGoldAndBuyButton

getset

◆ ShowHelpButton

bool SineSpace.Scripting.Client.SUI.ShowHelpButton

getset

Show the Help button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Help Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowHelpButton= true
    else
        Space.UI.ShowHelpButton= false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowHomeButton

bool SineSpace.Scripting.Client.SUI.ShowHomeButton

getset

Show the Home button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Home Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowHomeButton= true
    else
        Space.UI.ShowHomeButton= false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowHotBar

bool SineSpace.Scripting.Client.SUI.ShowHotBar

getset

Show the Hot Bar. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Hot Bar
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowHotBar= true
    else
        Space.UI.ShowHotBar= false
    end
end
 
toggle.OnValueChanged(OnValueChanged)

◆ ShowInventoryButton

bool SineSpace.Scripting.Client.SUI.ShowInventoryButton

getset

◆ ShowMailButton

bool SineSpace.Scripting.Client.SUI.ShowMailButton

getset

◆ ShowMiniMap

bool SineSpace.Scripting.Client.SUI.ShowMiniMap

getset

◆ ShowNotificationButton

bool SineSpace.Scripting.Client.SUI.ShowNotificationButton

getset

Show the Notification button. (white-label grid only)

&ndash;This script will make a UI Toggle show/hide the Notification Button
&ndash;(example: tools for user to customize UI)
&ndash;[You need to add an object with UI Toggle as a reference (scripting runtime)]
 
toggle = Space.Host.GetReference("Toggle").UIToggle
 
 
OnValueChanged = function()
    if toggle.IsOn then
        Space.UI.ShowNotificationButton= true
    else
        Space.UI.ShowNotificationButton= false
    end
end
 
toggle.OnValueChanged(OnValueChanged) 

◆ ShowOutfitButton

bool SineSpace.Scripting.Client.SUI.ShowOutfitButton

getset

◆ ShowProfileImage

bool SineSpace.Scripting.Client.SUI.ShowProfileImage

getset

◆ ShowQuestsButton

bool SineSpace.Scripting.Client.SUI.ShowQuestsButton

getset

◆ ShowRightButtonGroup

bool SineSpace.Scripting.Client.SUI.ShowRightButtonGroup

getset

◆ ShowRoomInfoOption

bool SineSpace.Scripting.Client.SUI.ShowRoomInfoOption

getset

◆ ShowSearch

bool SineSpace.Scripting.Client.SUI.ShowSearch

getset

◆ ShowShopButton

bool SineSpace.Scripting.Client.SUI.ShowShopButton

getset

◆ ShowSnapshotButton

bool SineSpace.Scripting.Client.SUI.ShowSnapshotButton

getset

◆ ShowUI

bool SineSpace.Scripting.Client.SUI.ShowUI

getset

◆ ShowWorldUI

bool SineSpace.Scripting.Client.SUI.ShowWorldUI

getset

◆ UIVolume

int SineSpace.Scripting.Client.SUI.UIVolume

getset

◆ VOIPVolume

int SineSpace.Scripting.Client.SUI.VOIPVolume

getset

Public Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ AddGlobalActionButton()

◆ AddNotification()

◆ ClearGlobalActionButton()

◆ HideBuyGoldWindow()

◆ HideChatWindow()

◆ HideEventsWindow()

◆ HideExitWindow()

◆ HideExploreWindow()

◆ HideFeedbackWindow()

◆ HideFriendsWindow()

◆ HideHelpWindow()

◆ HideHomeWindow()

◆ HideInventoryWindow()

◆ HideMailWindow()

◆ HideOutfitWindow()

◆ HideProfileWindow()

◆ HideQuestsWindow()

◆ HideRegionInfoWindow()

◆ HideRoomEditorWindow()

◆ HideSettingsWindow()

◆ HideShopWindow()

◆ HideSnapshotWindow()

◆ HideUpgradeAccountWindow()

◆ Initialise()

◆ OpenAppearanceEditor()

◆ OpenBuyGoldWindow()

◆ OpenChatWindow()

◆ OpenDevicePicker()

◆ OpenDeviceTester()

◆ OpenEventsWindow()

◆ OpenExitWindow()

◆ OpenExploreWindow()

◆ OpenFeedbackWindow()

◆ OpenFriendsWindow()

◆ OpenHelpWindow()

◆ OpenHomeWindow()

◆ OpenInventoryWindow()

◆ OpenMailWindow()

◆ OpenOutfitWindow()

◆ OpenProfileWin()

◆ OpenQuestsWindow()

◆ OpenRegionInfoWindow()

◆ OpenRoomEditorWindow()

◆ OpenSettingsWindow()

◆ OpenShopWindow()

◆ OpenSnapshotWindow()

◆ OpenUpgradeAccountWindow()

◆ Raycast()

◆ ShowLocation()

◆ ShowPathToLocation()

Property Documentation

◆ MasterVolume

◆ MusicVolume

◆ SFXVolume

◆ ShowActivityPanel

◆ ShowAuctionButton

◆ ShowChat

◆ ShowClock

◆ ShowCurrencyButton

◆ ShowEventsButton

◆ ShowExploreButton

◆ ShowFriendsButton

◆ ShowGoldAndBuyButton

◆ ShowHelpButton

◆ ShowHomeButton

◆ ShowHotBar

◆ ShowInventoryButton

◆ ShowMailButton

◆ ShowMiniMap

◆ ShowNotificationButton

◆ ShowOutfitButton

◆ ShowProfileImage

◆ ShowQuestsButton

◆ ShowRightButtonGroup

◆ ShowRoomInfoOption

◆ ShowSearch