Line 1: | Line 1: | ||
=Members= | =Members= | ||
− | {{ScriptFunction|void|OpenAppearanceEditor|()|Opens the Appearance Editor (Outfit)|5=<pre>Space.UI.OpenAppearanceEditor()</pre>}} | + | {{ScriptFunction|void|OpenAppearanceEditor|()|Opens the Appearance Editor (Outfit)|5=<pre>Space.UI.OpenAppearanceEditor()</pre>|6=<pre></pre>}} |
− | {{ScriptFunction|void|AddNotification|(string title, string text)|Shows a notification|5=<pre> Space.UI.AddNotification('Warning','This is a notification')</pre>}} | + | {{ScriptFunction|void|AddNotification|(string title, string text)|Shows a notification|5=<pre> Space.UI.AddNotification('Warning','This is a notification')</pre>|6=<pre></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() | {{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") | Space.Log("global action button pressed") | ||
end | end | ||
− | Space.UI.AddGlobalActionButton("The Button","The Tooltip", gbClick)</pre>}} | + | Space.UI.AddGlobalActionButton("The Button","The Tooltip", gbClick)</pre>|6=<pre></pre>}} |
− | {{ScriptFunction|void|ClearGlobalActionButton|(string button)|Clears a previously added Global Action Button 'button'|5=<pre> Space.UI.ClearGlobalActionButton("The Button")</pre>}} | + | {{ScriptFunction|void|ClearGlobalActionButton|(string button)|Clears a previously added Global Action Button 'button'|5=<pre> Space.UI.ClearGlobalActionButton("The Button")</pre>|6=<pre></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|ShowLocation|(string reason, SVector location)|Shows given location|5=<pre> Space.UI.ShowLocation("the reason", Vector.New(5,1,0))</pre>|6=<pre></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|ShowPathToLocation|(string reason, SVector location)|Shows a path to given location|5=<pre> Space.UI.ShowPathToLocation("the reason", Vector.New(5,1,0))</pre>|6=<pre></pre>}} |
− | {{ScriptFunction|void|OpenQuestsWindow|()|Opens the Quests window|5=<pre>Space.UI.OpenQuestsWindow()</pre> | + | {{ScriptFunction|void|OpenQuestsWindow|()|Opens the Quests window|5=<pre>Space.UI.OpenQuestsWindow()</pre>|6=<pre>--This script will make a button show/hide the Quests Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|HideQuestsWindow|()|Hides the Quests window|5=<pre>Space.UI.HideQuestsWindow()</pre>|6=<pre>--This script will make a button show/hide the Quests Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|OpenSettingsWindow|()|Opens the Settings window|5=<pre>Space.UI.OpenSettingsWindow()</pre>|6=<pre>--This script will make a button show/hide the Settings Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|HideSettingsWindow|()|Hides the Settings window|5=<pre>Space.UI.HideSettingsWindow()</pre>|6=<pre>--This script will make a button show/hide the Settings Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|OpenFriendsWindow|()|Opens the Friends window (white-label grid only)|5=<pre>Space.UI.OpenFriendsWindow()</pre>|6=<pre>--This script will make a button show/hide the Friends Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideFriendsWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenFriendsWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick)</pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|HideFriendsWindow|()|Hides the Friends window (white-label grid only)|5=<pre>Space.UI.HideFriendsWindow()</pre>|6=<pre>--This script will make a button show/hide the Friends Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideFriendsWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenFriendsWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick)</pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|OpenExploreWindow|()|Opens the Explore window (white-label grid only)|5=<pre>Space.UI.OpenExploreWindow()</pre>|6=<pre>--This script will make a button show/hide the Explore Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideExploreWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenExploreWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|HideExploreWindow|()|Hides the Explore window (white-label grid only)|5=<pre>Space.UI.HideExploreWindow()</pre>|6=<pre>--This script will make a button show/hide the Explore Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideExploreWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenExploreWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick) </pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|OpenEventsWindow|()|Opens the Events window (white-label grid only)|5=<pre>Space.UI.OpenEventsWindow()</pre>|6=<pre>--This script will make a button show/hide the Events Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideEventsWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenEventsWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick)</pre>}} | |
− | {{ScriptFunction|void| | + | {{ScriptFunction|void|HideEventsWindow|()|Hides the Events window (white-label grid only)|5=<pre>Space.UI.HideEventsWindow()</pre>|6=<pre>--This script will make a button show/hide the Events Window |
+ | --(example: tools for user to customize UI) | ||
+ | --[You need to add a UI Button as a reference in the Scripting Runtime Component] | ||
− | {{ScriptFunction|void|HideRoomEditorWindow|()|Hides the Room Editor window|5=<pre>Space.UI.HideRoomEditorWindow()</pre>}} | + | theButton = Space.Host.GetReference('TheButton') |
+ | local isShown = false | ||
+ | |||
+ | OnClick = function() | ||
+ | if isShown then | ||
+ | Space.UI.HideEventsWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenEventsWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenHomeWindow|()|Opens the Home window (white-label grid only)|5=<pre>Space.UI.OpenHomeWindow()</pre>|6=<pre>--This script will make a button show/hide the Home Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideHomeWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenHomeWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideHomeWindow|()|Hides the Home window (white-label grid only)|5=<pre>Space.UI.HideHomeWindow()</pre>|6=<pre>--This script will make a button show/hide the Home Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideHomeWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenHomeWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenInventoryWindow|()|Opens the Inventory window (white-label grid only)|5=<pre>Space.UI.OpenInventoryWindow()</pre>|6=<pre>--This script will make a button show/hide the Inventory Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideInventoryWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenInventoryWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideInventoryWindow|()|Hides the Inventory window (white-label grid only)|5=<pre>Space.UI.HideInventoryWindow()</pre>|6=<pre>--This script will make a button show/hide the Inventory Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideInventoryWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenInventoryWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenOutfitWindow|()|Opens the Outfit window (white-label grid only)|5=<pre>Space.UI.OpenOutfitWindow()</pre>|6=<pre>--This script will make a button show/hide the Outfit Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideOutfitWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenOutfitWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideOutfitWindow|()|Hides the Outfit window (white-label grid only)|5=<pre>Space.UI.HideOutfitWindow()</pre>|6=<pre>--This script will make a button show/hide the Outfit Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideOutfitWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenOutfitWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenShopWindow|()|Opens the Shop window (white-label grid only)|5=<pre>Space.UI.OpenShopWindow()</pre>|6=<pre>--This script will make a button show/hide the Shop Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideShopWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenShopWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideShopWindow|()|Hides the Shop window (white-label grid only)|5=<pre>Space.UI.HideShopWindow()</pre>|6=<pre>--This script will make a button show/hide the Shop Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideShopWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenShopWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenSnapshotWindow|()|Opens the Snapshot window (white-label grid only)|5=<pre>Space.UI.OpenSnapshotWindow()</pre>|6=<pre>--This script will make a button show/hide the Snapshot Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideSnapshotWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenSnapshotWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideSnapshotWindow|()|Hides the Snapshot window (white-label grid only)|5=<pre>Space.UI.HideSnapshotWindow()</pre>|6=<pre>--This script will make a button show/hide the Snapshot Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideSnapshotWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenSnapshotWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenHelpWindow|()|Opens the Help window (white-label grid only)|5=<pre>Space.UI.OpenHelpWindow()</pre>|6=<pre>--This script will make a button show/hide the Help Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideHelpWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenHelpWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideHelpWindow|()|Hides the Help window (white-label grid only)|5=<pre>Space.UI.HideHelpWindow()</pre>|6=<pre>--This script will make a button show/hide the Help Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideHelpWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenHelpWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenProfileWin|()|Opens the Profile window (white-label grid only)|5=<pre>Space.UI.OpenProfileWin()</pre>|6=<pre>--This script will make a button show/hide the Profile Win | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideProfileWin() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenProfileWin() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideProfileWin|()|Hides the Profile window (white-label grid only)|5=<pre>Space.UI.HideProfileWin()</pre>|6=<pre>--This script will make a button show/hide the Profile Win | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideProfileWin() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenProfileWin() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenUpgradeAccountWindow|()|Opens the Upgrade Account window (white-label grid only)|5=<pre>Space.UI.OpenUpgradeAccountWindow()</pre>|6=<pre>--This script will make a button show/hide the Upgrade Account Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideUpgradeAccountWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenUpgradeAccountWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideUpgradeAccountWindow|()|Hides the Upgrade Account window (white-label grid only)|5=<pre>Space.UI.HideUpgradeAccountWindow()</pre>|6=<pre>--This script will make a button show/hide the Upgrade Account Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideUpgradeAccountWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenUpgradeAccountWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenRegionInfoWindow|()|Opens the Region Info window (white-label grid only)|5=<pre>Space.UI.OpenRegionInfoWindow()</pre>|6=<pre>--This script will make a button show/hide the Region Info Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideRegionInfoWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenRegionInfoWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideRegionInfoWindow|()|Hides the Region Info window (white-label grid only)|5=<pre>Space.UI.HideRegionInfoWindow()</pre>|6=<pre>--This script will make a button show/hide the Region Info Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideRegionInfoWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenRegionInfoWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenExitWindow|()|Opens the Exit window (white-label grid only)|5=<pre>Space.UI.OpenExitWindow()</pre>|6=<pre>--This script will make a button show/hide the Exit Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideExitWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenExitWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideExitWindow|()|Hides the Exit window (white-label grid only)|5=<pre>Space.UI.HideExitWindow()</pre>|6=<pre>--This script will make a button show/hide the Exit Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideExitWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenExitWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenMailWindow|()|Opens the Mail window (white-label grid only)|5=<pre>Space.UI.OpenMailWindow()</pre>|6=<pre>--This script will make a button show/hide the Mail Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideMailWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenMailWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideMailWindow|()|Hides the Mail window (white-label grid only)|5=<pre>Space.UI.HideMailWindow()</pre>|6=<pre>--This script will make a button show/hide the Mail Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideMailWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenMailWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenBuyGoldWindow|()|Opens the Buy Gold window (white-label grid only)|5=<pre>Space.UI.OpenBuyGoldWindow()</pre>|6=<pre>--This script will make a button show/hide the Buy Gold Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideBuyGoldWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenBuyGoldWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideBuyGoldWindow|()|Hides the Buy Gold window (white-label grid only)|5=<pre>Space.UI.HideBuyGoldWindow()</pre>|6=<pre>--This script will make a button show/hide the Buy Gold Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideBuyGoldWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenBuyGoldWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenChatWindow|()|Opens the Chat window (white-label grid only)|5=<pre>Space.UI.OpenChatWindow()</pre>|6=<pre>--This script will make a button show/hide the Chat Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideChatWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenChatWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideChatWindow|()|Hides the Chat window (white-label grid only)|5=<pre>Space.UI.HideChatWindow()</pre>|6=<pre>--This script will make a button show/hide the Chat Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[You need to add a UI Button as a reference in the Scripting Runtime Component] | ||
+ | |||
+ | theButton = Space.Host.GetReference('TheButton') | ||
+ | local isShown = true | ||
+ | |||
+ | OnClick = function() | ||
+ | if isShown then | ||
+ | Space.UI.HideChatWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenChatWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenRoomEditorWindow|()|Opens the Room Editor window (white-label grid only)|5=<pre>Space.UI.OpenRoomEditorWindow()</pre>|6=<pre>--This script will make a button show/hide the Room Editor Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideRoomEditorWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenRoomEditorWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|HideRoomEditorWindow|()|Hides the Room Editor window (white-label grid only)|5=<pre>Space.UI.HideRoomEditorWindow()</pre>|6=<pre>--This script will make a button show/hide the Room Editor Window | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.HideRoomEditorWindow() | ||
+ | isShown = false | ||
+ | else | ||
+ | Space.UI.OpenRoomEditorWindow() | ||
+ | isShown = true | ||
+ | end | ||
+ | end | ||
+ | |||
+ | theButton.UIButton.OnClick(OnClick)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|void|OpenDevicePicker|()|Opens the Device Picker (white-label grid only)|5=<pre>Space.UI.OpenDevicePicker()</pre>|6=<pre>--This script will make a button open the Device Picker | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[You need to add a UI Button as a reference in the Scripting Runtime Component] | ||
+ | |||
+ | theButton = Space.Host.GetReference('TheButton') | ||
+ | |||
+ | OnClick = function() | ||
+ | Space.UI.OpenDevicePicker() | ||
+ | end | ||
− | + | theButton.UIButton.OnClick(OnClick)</pre>}} | |
− | {{ScriptFunction|SUIRaycastResult|Raycast|()|Shoots a UI Raycast and returns the result as SUIRayCastResult|5=<pre>RayCastResult= Space.UI.Raycast()</pre>}} | + | {{ScriptFunction|SUIRaycastResult|Raycast|()|Shoots a UI Raycast and returns the result as SUIRayCastResult|5=<pre>RayCastResult= Space.UI.Raycast()</pre>|6=<pre></pre>}} |
Line 99: | Line 755: | ||
=Properties= | =Properties= | ||
− | {{ScriptFunction|bool|ShowAuctionButton|{ get; set; }|Show the Auction button|5= <pre>Space.UI.ShowAuctionButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Auction Button | + | {{ScriptFunction|bool|ShowAuctionButton|{ get; set; }|Show the Auction button |5= <pre>Space.UI.ShowAuctionButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Auction Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 116: | Line 772: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowChat|{ get; set; }|Show the Chat|5= <pre>Space.UI.ShowChat = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Chat | + | {{ScriptFunction|bool|ShowChat|{ get; set; }|Show the Chat |5= <pre>Space.UI.ShowChat = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Chat |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 133: | Line 789: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowCurrencyButton|{ get; set; }|Show the Currency button|5= <pre>Space.UI.ShowCurrencyButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Currency Button | + | {{ScriptFunction|bool|ShowCurrencyButton|{ get; set; }|Show the Currency button |5= <pre>Space.UI.ShowCurrencyButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Currency Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 235: | Line 891: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowInventoryButton|{ get; set; }|Show the Inventory button|5= <pre>Space.UI.ShowInventoryButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Inventory Button | + | {{ScriptFunction|bool|ShowInventoryButton|{ get; set; }|Show the Inventory button (white-label grid only)|5= <pre>Space.UI.ShowInventoryButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Inventory Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 252: | Line 908: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowMiniMap|{ get; set; }|Set to true to show the Minimap|5= <pre>Space.UI.ShowMiniMap = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Minimap | + | {{ScriptFunction|bool|ShowMiniMap|{ get; set; }|Set to true to show the Minimap (white-label grid only)|5= <pre>Space.UI.ShowMiniMap = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Minimap |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 269: | Line 925: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowOutfitButton|{ get; set; }|Set to true to show the Outfit button|5= <pre>Space.UI.ShowOutfitButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Outfit Button | + | {{ScriptFunction|bool|ShowOutfitButton|{ get; set; }|Set to true to show the Outfit button (white-label grid only)|5= <pre>Space.UI.ShowOutfitButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Outfit Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 286: | Line 942: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowQuestsButton|{ get; set; }|Show the Quests button|5= <pre>Space.UI.ShowQuestsButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Quests button | + | {{ScriptFunction|bool|ShowQuestsButton|{ get; set; }|Show the Quests button (white-label grid only)|5= <pre>Space.UI.ShowQuestsButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Quests button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 303: | Line 959: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowShopButton|{ get; set; }|Show the Shop button|5= <pre>Space.UI.ShowShopButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Shop Button | + | {{ScriptFunction|bool|ShowShopButton|{ get; set; }|Show the Shop button (white-label grid only)|5= <pre>Space.UI.ShowShopButton = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Shop Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 320: | Line 976: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowSnapshotButton|{ get; set; }|Show the Snapshot button|5= <pre>Space.UI.ShowSnapshotButton = false</pre>}} | + | {{ScriptFunction|bool|ShowSnapshotButton|{ get; set; }|Show the Snapshot button (white-label grid only)|5= <pre>Space.UI.ShowSnapshotButton = false</pre>}} |
{{ScriptFunction|bool|ShowUI|{ get; set; }|Show the User Interface|5= <pre>Space.UI.ShowUI = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the User Interface | {{ScriptFunction|bool|ShowUI|{ get; set; }|Show the User Interface|5= <pre>Space.UI.ShowUI = false</pre>|6=<pre>--This script will make a UI Toggle show/hide the User Interface | ||
Line 340: | Line 996: | ||
− | {{ScriptFunction|bool|ShowWorldUI|{ get; set; }|Show the World User Interface|5= <pre>Space.UI.ShowUI = false</pre>}} | + | {{ScriptFunction|bool|ShowWorldUI|{ get; set; }|Show the World User Interface|5= <pre>Space.UI.ShowUI = false</pre>|6=<pre></pre>}} |
{{ScriptFunction|int|MusicVolume|{ get; set; }|Set/Get the Music volume|5= <pre>MusicVolume= Space.UI.MusicVolume</pre>|6=<pre>--This script will make moving a slider control the Music Volume | {{ScriptFunction|int|MusicVolume|{ get; set; }|Set/Get the Music volume|5= <pre>MusicVolume= Space.UI.MusicVolume</pre>|6=<pre>--This script will make moving a slider control the Music Volume | ||
Line 422: | Line 1,078: | ||
slider.OnValueChanged(OnValueChanged) </pre>}} | slider.OnValueChanged(OnValueChanged) </pre>}} | ||
− | {{ScriptFunction|bool|ShowEventsButton|{ get; set; }|Show the Events button|5= <pre>Space.UI.ShowEventsButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Events button | + | {{ScriptFunction|bool|ShowEventsButton|{ get; set; }|Show the Events button (white-label grid only)|5= <pre>Space.UI.ShowEventsButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Events button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 439: | Line 1,095: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowGoldAndBuyButton|{ get; set; }|Show the Gold and Buy button|5= <pre>Space.UI.ShowGoldAndBuyButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Gold and Buy button | + | {{ScriptFunction|bool|ShowGoldAndBuyButton|{ get; set; }|Show the Gold and Buy button (white-label grid only)|5= <pre>Space.UI.ShowGoldAndBuyButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Gold and Buy button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 456: | Line 1,112: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowClock|{ get; set; }|Show the clock|5= <pre>Space.UI.ShowClock= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Clock | + | {{ScriptFunction|bool|ShowClock|{ get; set; }|Show the clock (white-label grid only)|5= <pre>Space.UI.ShowClock= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Clock |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 473: | Line 1,129: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowActivityPanel|{ get; set; }|Show the Activity Panel|5= <pre>Space.UI.ShowActivityPanel= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Activity Panel | + | {{ScriptFunction|bool|ShowActivityPanel|{ get; set; }|Show the Activity Panel (white-label grid only)|5= <pre>Space.UI.ShowActivityPanel= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Activity Panel |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 490: | Line 1,146: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowProfileImage|{ get; set; }|Show the Profile Image|5= <pre>Space.UI.ShowProfileImage= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Profile Image | + | {{ScriptFunction|bool|ShowProfileImage|{ get; set; }|Show the Profile Image (white-label grid only)|5= <pre>Space.UI.ShowProfileImage= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Profile Image |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 507: | Line 1,163: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowRightButtonGroup|{ get; set; }|Show the Button | + | {{ScriptFunction|bool|ShowRightButtonGroup|{ get; set; }|Show the Right Button Group (white-label grid only)|5= <pre>Space.UI.ShowRightButtonGroup= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Right Button Group |
+ | --(example: tools for user to customize UI) | ||
+ | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
− | {{ScriptFunction|bool|ShowRoomInfoOption|{ get; set; }|Show the Room Info Option|5= <pre>Space.UI.ShowRoomInfoOption= false</pre>}} | + | toggle = Space.Host.GetReference("Toggle").UIToggle |
+ | |||
+ | |||
+ | OnValueChanged = function() | ||
+ | if toggle.IsOn then | ||
+ | Space.UI.ShowRightButtonGroup= true | ||
+ | else | ||
+ | Space.UI.ShowRightButtonGroup= false | ||
+ | end | ||
+ | end | ||
+ | |||
+ | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
+ | |||
+ | {{ScriptFunction|bool|ShowRoomInfoOption|{ get; set; }|Show the Room Info Option (white-label grid only)|5= <pre>Space.UI.ShowRoomInfoOption= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Room Info Option | ||
+ | --(example: tools for user to customize UI) | ||
+ | --[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.ShowRoomInfoOption= true | ||
+ | else | ||
+ | Space.UI.ShowRoomInfoOption= false | ||
+ | end | ||
+ | end | ||
+ | |||
+ | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowSearch|{ get; set; }|Show the Search bar|5= <pre>Space.UI.ShowSearch= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Search Bar | + | {{ScriptFunction|bool|ShowSearch|{ get; set; }|Show the Search bar (white-label grid only)|5= <pre>Space.UI.ShowSearch= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Search Bar |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] | ||
Line 528: | Line 1,214: | ||
toggle.OnValueChanged(OnValueChanged)</pre>}} | toggle.OnValueChanged(OnValueChanged)</pre>}} | ||
− | {{ScriptFunction|bool|ShowMailButton|{ get; set; }|Show the Mail button|5= <pre>Space.UI.ShowMailButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Mail Button | + | {{ScriptFunction|bool|ShowMailButton|{ get; set; }|Show the Mail button (white-label grid only)|5= <pre>Space.UI.ShowMailButton= false</pre>|6=<pre>--This script will make a UI Toggle show/hide the Mail Button |
--(example: tools for user to customize UI) | --(example: tools for user to customize UI) | ||
--[You need to add an object with UI Toggle as a reference (scripting runtime)] | --[You need to add an object with UI Toggle as a reference (scripting runtime)] |
Opens the Appearance Editor (Outfit)
Space.UI.OpenAppearanceEditor()
Shows a notification
Space.UI.AddNotification('Warning','This is a notification')
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)
Clears a previously added Global Action Button 'button'
Space.UI.ClearGlobalActionButton("The Button")
Shows given location
Space.UI.ShowLocation("the reason", Vector.New(5,1,0))
Shows a path to given location
Space.UI.ShowPathToLocation("the reason", Vector.New(5,1,0))
Opens the Quests window
Space.UI.OpenQuestsWindow()
--This script will make a button show/hide the Quests Window --(example: tools for user to customize UI) --[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() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Quests window
Space.UI.HideQuestsWindow()
--This script will make a button show/hide the Quests Window --(example: tools for user to customize UI) --[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() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Settings window
Space.UI.OpenSettingsWindow()
--This script will make a button show/hide the Settings Window --(example: tools for user to customize UI) --[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() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Settings window
Space.UI.HideSettingsWindow()
--This script will make a button show/hide the Settings Window --(example: tools for user to customize UI) --[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() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Friends window (white-label grid only)
Space.UI.OpenFriendsWindow()
--This script will make a button show/hide the Friends Window --(example: tools for user to customize UI) --[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.HideFriendsWindow() isShown = false else Space.UI.OpenFriendsWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Friends window (white-label grid only)
Space.UI.HideFriendsWindow()
--This script will make a button show/hide the Friends Window --(example: tools for user to customize UI) --[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.HideFriendsWindow() isShown = false else Space.UI.OpenFriendsWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Explore window (white-label grid only)
Space.UI.OpenExploreWindow()
--This script will make a button show/hide the Explore Window --(example: tools for user to customize UI) --[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.HideExploreWindow() isShown = false else Space.UI.OpenExploreWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Explore window (white-label grid only)
Space.UI.HideExploreWindow()
--This script will make a button show/hide the Explore Window --(example: tools for user to customize UI) --[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.HideExploreWindow() isShown = false else Space.UI.OpenExploreWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Events window (white-label grid only)
Space.UI.OpenEventsWindow()
--This script will make a button show/hide the Events Window --(example: tools for user to customize UI) --[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.HideEventsWindow() isShown = false else Space.UI.OpenEventsWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Events window (white-label grid only)
Space.UI.HideEventsWindow()
--This script will make a button show/hide the Events Window --(example: tools for user to customize UI) --[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.HideEventsWindow() isShown = false else Space.UI.OpenEventsWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Home window (white-label grid only)
Space.UI.OpenHomeWindow()
--This script will make a button show/hide the Home Window --(example: tools for user to customize UI) --[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.HideHomeWindow() isShown = false else Space.UI.OpenHomeWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Home window (white-label grid only)
Space.UI.HideHomeWindow()
--This script will make a button show/hide the Home Window --(example: tools for user to customize UI) --[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.HideHomeWindow() isShown = false else Space.UI.OpenHomeWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Inventory window (white-label grid only)
Space.UI.OpenInventoryWindow()
--This script will make a button show/hide the Inventory Window --(example: tools for user to customize UI) --[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.HideInventoryWindow() isShown = false else Space.UI.OpenInventoryWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Inventory window (white-label grid only)
Space.UI.HideInventoryWindow()
--This script will make a button show/hide the Inventory Window --(example: tools for user to customize UI) --[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.HideInventoryWindow() isShown = false else Space.UI.OpenInventoryWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Outfit window (white-label grid only)
Space.UI.OpenOutfitWindow()
--This script will make a button show/hide the Outfit Window --(example: tools for user to customize UI) --[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.HideOutfitWindow() isShown = false else Space.UI.OpenOutfitWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Outfit window (white-label grid only)
Space.UI.HideOutfitWindow()
--This script will make a button show/hide the Outfit Window --(example: tools for user to customize UI) --[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.HideOutfitWindow() isShown = false else Space.UI.OpenOutfitWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Shop window (white-label grid only)
Space.UI.OpenShopWindow()
--This script will make a button show/hide the Shop Window --(example: tools for user to customize UI) --[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.HideShopWindow() isShown = false else Space.UI.OpenShopWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Shop window (white-label grid only)
Space.UI.HideShopWindow()
--This script will make a button show/hide the Shop Window --(example: tools for user to customize UI) --[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.HideShopWindow() isShown = false else Space.UI.OpenShopWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Snapshot window (white-label grid only)
Space.UI.OpenSnapshotWindow()
--This script will make a button show/hide the Snapshot Window --(example: tools for user to customize UI) --[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.HideSnapshotWindow() isShown = false else Space.UI.OpenSnapshotWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Snapshot window (white-label grid only)
Space.UI.HideSnapshotWindow()
--This script will make a button show/hide the Snapshot Window --(example: tools for user to customize UI) --[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.HideSnapshotWindow() isShown = false else Space.UI.OpenSnapshotWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Help window (white-label grid only)
Space.UI.OpenHelpWindow()
--This script will make a button show/hide the Help Window --(example: tools for user to customize UI) --[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.HideHelpWindow() isShown = false else Space.UI.OpenHelpWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Help window (white-label grid only)
Space.UI.HideHelpWindow()
--This script will make a button show/hide the Help Window --(example: tools for user to customize UI) --[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.HideHelpWindow() isShown = false else Space.UI.OpenHelpWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Profile window (white-label grid only)
Space.UI.OpenProfileWin()
--This script will make a button show/hide the Profile Win --(example: tools for user to customize UI) --[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.HideProfileWin() isShown = false else Space.UI.OpenProfileWin() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Profile window (white-label grid only)
Space.UI.HideProfileWin()
--This script will make a button show/hide the Profile Win --(example: tools for user to customize UI) --[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.HideProfileWin() isShown = false else Space.UI.OpenProfileWin() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Upgrade Account window (white-label grid only)
Space.UI.OpenUpgradeAccountWindow()
--This script will make a button show/hide the Upgrade Account Window --(example: tools for user to customize UI) --[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.HideUpgradeAccountWindow() isShown = false else Space.UI.OpenUpgradeAccountWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Upgrade Account window (white-label grid only)
Space.UI.HideUpgradeAccountWindow()
--This script will make a button show/hide the Upgrade Account Window --(example: tools for user to customize UI) --[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.HideUpgradeAccountWindow() isShown = false else Space.UI.OpenUpgradeAccountWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Region Info window (white-label grid only)
Space.UI.OpenRegionInfoWindow()
--This script will make a button show/hide the Region Info Window --(example: tools for user to customize UI) --[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.HideRegionInfoWindow() isShown = false else Space.UI.OpenRegionInfoWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Region Info window (white-label grid only)
Space.UI.HideRegionInfoWindow()
--This script will make a button show/hide the Region Info Window --(example: tools for user to customize UI) --[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.HideRegionInfoWindow() isShown = false else Space.UI.OpenRegionInfoWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Exit window (white-label grid only)
Space.UI.OpenExitWindow()
--This script will make a button show/hide the Exit Window --(example: tools for user to customize UI) --[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.HideExitWindow() isShown = false else Space.UI.OpenExitWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Exit window (white-label grid only)
Space.UI.HideExitWindow()
--This script will make a button show/hide the Exit Window --(example: tools for user to customize UI) --[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.HideExitWindow() isShown = false else Space.UI.OpenExitWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Mail window (white-label grid only)
Space.UI.OpenMailWindow()
--This script will make a button show/hide the Mail Window --(example: tools for user to customize UI) --[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.HideMailWindow() isShown = false else Space.UI.OpenMailWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Mail window (white-label grid only)
Space.UI.HideMailWindow()
--This script will make a button show/hide the Mail Window --(example: tools for user to customize UI) --[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.HideMailWindow() isShown = false else Space.UI.OpenMailWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Buy Gold window (white-label grid only)
Space.UI.OpenBuyGoldWindow()
--This script will make a button show/hide the Buy Gold Window --(example: tools for user to customize UI) --[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.HideBuyGoldWindow() isShown = false else Space.UI.OpenBuyGoldWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Buy Gold window (white-label grid only)
Space.UI.HideBuyGoldWindow()
--This script will make a button show/hide the Buy Gold Window --(example: tools for user to customize UI) --[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.HideBuyGoldWindow() isShown = false else Space.UI.OpenBuyGoldWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Chat window (white-label grid only)
Space.UI.OpenChatWindow()
--This script will make a button show/hide the Chat Window --(example: tools for user to customize UI) --[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.HideChatWindow() isShown = false else Space.UI.OpenChatWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Chat window (white-label grid only)
Space.UI.HideChatWindow()
--This script will make a button show/hide the Chat Window --(example: tools for user to customize UI) --[You need to add a UI Button as a reference in the Scripting Runtime Component] theButton = Space.Host.GetReference('TheButton') local isShown = true OnClick = function() if isShown then Space.UI.HideChatWindow() isShown = false else Space.UI.OpenChatWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Room Editor window (white-label grid only)
Space.UI.OpenRoomEditorWindow()
--This script will make a button show/hide the Room Editor Window --(example: tools for user to customize UI) --[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.HideRoomEditorWindow() isShown = false else Space.UI.OpenRoomEditorWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Hides the Room Editor window (white-label grid only)
Space.UI.HideRoomEditorWindow()
--This script will make a button show/hide the Room Editor Window --(example: tools for user to customize UI) --[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.HideRoomEditorWindow() isShown = false else Space.UI.OpenRoomEditorWindow() isShown = true end end theButton.UIButton.OnClick(OnClick)
Opens the Device Picker (white-label grid only)
Space.UI.OpenDevicePicker()
--This script will make a button open the Device Picker --(example: tools for user to customize UI) --[You need to add a UI Button as a reference in the Scripting Runtime Component] theButton = Space.Host.GetReference('TheButton') OnClick = function() Space.UI.OpenDevicePicker() end theButton.UIButton.OnClick(OnClick)
Shoots a UI Raycast and returns the result as SUIRayCastResult
RayCastResult= Space.UI.Raycast()
Show the Auction button
Space.UI.ShowAuctionButton = false
--This script will make a UI Toggle show/hide the Auction Button --(example: tools for user to customize UI) --[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)
Show the Chat
Space.UI.ShowChat = false
--This script will make a UI Toggle show/hide the Chat --(example: tools for user to customize UI) --[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)
Show the Currency button
Space.UI.ShowCurrencyButton = false
--This script will make a UI Toggle show/hide the Currency Button --(example: tools for user to customize UI) --[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.ShowCurrencyButton= true else Space.UI.ShowCurrencyButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the Explore button
Space.UI.ShowExploreButton = false
--This script will make a UI Toggle show/hide the Explore Button --(example: tools for user to customize UI) --[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)
Show the Friends button
Space.UI.ShowFriendsButton = false
--This script will make a UI Toggle show/hide the Friends Button --(example: tools for user to customize UI) --[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)
Show the Help button
Space.UI.ShowHelpButton = false
--This script will make a UI Toggle show/hide the Help Button --(example: tools for user to customize UI) --[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)
Show the Home button
Space.UI.ShowHomeButton = false
--This script will make a UI Toggle show/hide the Home Button --(example: tools for user to customize UI) --[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)
Show the Hot Bar
Space.UI.ShowHotBar = false
--This script will make a UI Toggle show/hide the Hot Bar --(example: tools for user to customize UI) --[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)
Show the Inventory button (white-label grid only)
Space.UI.ShowInventoryButton = false
--This script will make a UI Toggle show/hide the Inventory Button --(example: tools for user to customize UI) --[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.ShowInventoryButton= true else Space.UI.ShowInventoryButton= false end end toggle.OnValueChanged(OnValueChanged)
Set to true to show the Minimap (white-label grid only)
Space.UI.ShowMiniMap = false
--This script will make a UI Toggle show/hide the Minimap --(example: tools for user to customize UI) --[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.ShowMiniMap= true else Space.UI.ShowMiniMap= false end end toggle.OnValueChanged(OnValueChanged)
Set to true to show the Outfit button (white-label grid only)
Space.UI.ShowOutfitButton = false
--This script will make a UI Toggle show/hide the Outfit Button --(example: tools for user to customize UI) --[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.ShowOutfitButton= true else Space.UI.ShowOutfitButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the Quests button (white-label grid only)
Space.UI.ShowQuestsButton = false
--This script will make a UI Toggle show/hide the Quests button --(example: tools for user to customize UI) --[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.ShowQuestsButton= true else Space.UI.ShowQuestsButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the Shop button (white-label grid only)
Space.UI.ShowShopButton = false
--This script will make a UI Toggle show/hide the Shop Button --(example: tools for user to customize UI) --[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.ShowShopButton= true else Space.UI.ShowShopButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the Snapshot button (white-label grid only)
Space.UI.ShowSnapshotButton = false
Show the User Interface
Space.UI.ShowUI = false
--This script will make a UI Toggle show/hide the User Interface --(example: tools for user to customize UI) --[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.ShowUI= true else Space.UI.ShowUI= false end end toggle.OnValueChanged(OnValueChanged)
Show the World User Interface
Space.UI.ShowUI = false
Set/Get the Music volume
MusicVolume= Space.UI.MusicVolume
--This script will make moving a slider control the Music Volume --and also update a text field with the current Music Volume --(example: custom UI) --[You need to add the slider and text field as a reference] slider = Space.Host.GetReference("Slider").UISlider textField = Space.Host.GetReference("Text Field").UIText OnValueChanged = function() Space.UI.MusicVolume = slider.NormalizedValue * 100 textField.Text = Space.UI.MusicVolume end slider.OnValueChanged(OnValueChanged)
Set/Get the Master volume
MasterVolume= Space.UI.MasterVolume
--This script will make moving a slider control the Master Volume --and also update a text field with the current Master Volume --(example: custom UI) --[You need to add the slider and text field as a reference] slider = Space.Host.GetReference("Slider").UISlider textField = Space.Host.GetReference("Text Field").UIText OnValueChanged = function() Space.UI.MasterVolume = slider.NormalizedValue * 100 textField.Text = Space.UI.MasterVolume end slider.OnValueChanged(OnValueChanged)
Set/Get the SFX volume
SFXVolume= Space.UI.SFXVolume
--This script will make moving a slider control the SFX Volume --and also update a text field with the current SFX Volume --(example: custom UI) --[You need to add the slider and text field as a reference] slider = Space.Host.GetReference("Slider").UISlider textField = Space.Host.GetReference("Text Field").UIText OnValueChanged = function() Space.UI.SFXVolume = slider.NormalizedValue * 100 textField.Text = Space.UI.SFXVolume end slider.OnValueChanged(OnValueChanged)
Set/Get the UI volume
UIVolume= Space.UI.UIVolume
--This script will make moving a slider control the UI Volume --and also update a text field with the current UI Volume --(example: custom UI) --[You need to add the slider and text field as a reference] slider = Space.Host.GetReference("Slider").UISlider textField = Space.Host.GetReference("Text Field").UIText OnValueChanged = function() Space.UI.UIVolume = slider.NormalizedValue * 100 textField.Text = Space.UI.UIVolume end slider.OnValueChanged(OnValueChanged)
Set/Get the VOIP volume
VOIPVolume = Space.UI.VOIPVolume
--This script will make moving a slider control the Voice Volume --and also update a text field with the current Voice Volume --(example: custom UI) --[You need to add the slider and text field as a reference] slider = Space.Host.GetReference("Slider").UISlider textField = Space.Host.GetReference("Text Field").UIText OnValueChanged = function() Space.UI.VOIPVolume = slider.NormalizedValue * 100 textField.Text = Space.UI.VOIPVolume end slider.OnValueChanged(OnValueChanged)
Show the Events button (white-label grid only)
Space.UI.ShowEventsButton= false
--This script will make a UI Toggle show/hide the Events button --(example: tools for user to customize UI) --[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.ShowEventsButton= true else Space.UI.ShowEventsButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the Gold and Buy button (white-label grid only)
Space.UI.ShowGoldAndBuyButton= false
--This script will make a UI Toggle show/hide the Gold and Buy button --(example: tools for user to customize UI) --[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.ShowGoldAndBuyButton= true else Space.UI.ShowGoldAndBuyButton= false end end toggle.OnValueChanged(OnValueChanged)
Show the clock (white-label grid only)
Space.UI.ShowClock= false
--This script will make a UI Toggle show/hide the Clock --(example: tools for user to customize UI) --[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.ShowClock= true else Space.UI.ShowClock= false end end toggle.OnValueChanged(OnValueChanged)
Show the Activity Panel (white-label grid only)
Space.UI.ShowActivityPanel= false
--This script will make a UI Toggle show/hide the Activity Panel --(example: tools for user to customize UI) --[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.ShowActivityPanel= true else Space.UI.ShowActivityPanel= false end end toggle.OnValueChanged(OnValueChanged)
Show the Profile Image (white-label grid only)
Space.UI.ShowProfileImage= false
--This script will make a UI Toggle show/hide the Profile Image --(example: tools for user to customize UI) --[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.ShowProfileImage= true else Space.UI.ShowProfileImage= false end end toggle.OnValueChanged(OnValueChanged)
Show the Right Button Group (white-label grid only)
Space.UI.ShowRightButtonGroup= false
--This script will make a UI Toggle show/hide the Right Button Group --(example: tools for user to customize UI) --[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.ShowRightButtonGroup= true else Space.UI.ShowRightButtonGroup= false end end toggle.OnValueChanged(OnValueChanged)
Show the Room Info Option (white-label grid only)
Space.UI.ShowRoomInfoOption= false
--This script will make a UI Toggle show/hide the Room Info Option --(example: tools for user to customize UI) --[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.ShowRoomInfoOption= true else Space.UI.ShowRoomInfoOption= false end end toggle.OnValueChanged(OnValueChanged)
Show the Search bar (white-label grid only)
Space.UI.ShowSearch= false
--This script will make a UI Toggle show/hide the Search Bar --(example: tools for user to customize UI) --[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.ShowSearch= true else Space.UI.ShowSearch= false end end toggle.OnValueChanged(OnValueChanged)
Show the Mail button (white-label grid only)
Space.UI.ShowMailButton= false
--This script will make a UI Toggle show/hide the Mail Button --(example: tools for user to customize UI) --[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.ShowMailButton = true else Space.UI.ShowMailButton = false end end toggle.OnValueChanged(OnValueChanged)
Show the Notification button
Space.UI.ShowNotificationButton= false
--This script will make a UI Toggle show/hide the Notification Button --(example: tools for user to customize UI) --[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)
|