wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUserRegions"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/suserregions")
 
Line 1: Line 1:
=Public Attributes=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/suserregions
 
+
{{ScriptFunction|int|SubscriptionTier| |The subscription tier indicates which type of premium memberhsip the player has. (As found in "Region" window)|5=|6=<pre>--Make's a UIText show this User's Regions' current Subscription Tier
+
 
+
textObject = Space.Host.GetReference("TheTextReference") --add to References section in Scripting Runtime
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.SubscriptionTier
+
  text.UIText.Text = r
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|int|NumberOfRegions| |The number of regions the player has. (As found in "Region" window)|5=|6=<pre>--Make's a UIText show this User's Regions' current NumberOfRegions
+
 
+
textObject = Space.Host.GetReference("TheTextReference") --add to References section in Scripting Runtime
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.NumberOfRegions
+
  text.UIText.Text = r
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|int|UsersPerRegion| |The max number of users allowed per region. ("Concurrency" as found in "Region" window).|5=|6=<pre>--Make's a UIText show this User's Regions' current UsersPerRegion
+
 
+
textObject = Space.Host.GetReference("TheTextReference") --add to References section in Scripting Runtime
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.UsersPerRegion
+
  text.UIText.Text = r
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|int|FileSize| |The maximum MB size the player's regions can be. ("Max Region SizE" in the "Region" window)|5=|6=<pre>--Make's a UIText show this User's Regions' current FileSize
+
 
+
textObject = Space.Host.GetReference("TheTextReference") --add to References section in Scripting Runtime
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.FileSize
+
  text.UIText.Text = r
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|string|SubscriptionName| |The name of the current player's premium subscription (as found in "Region" window)|5=|6=<pre>--Make's a UIText show this User's Regions' current SubscriptionName
+
 
+
textObject = Space.Host.GetReference("TheTextReference") --add to References section in Scripting Runtime
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.SubscriptionName
+
  text.UIText.Text = r
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|SPublicRegion[]|AvailableRegions| |Returns an array of SPublicRegion which is a group of data for each of the user's available regions. |5=|6=<pre>--Make's a UIText show the Name of the user's first available region
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.Name
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 08:08, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/suserregions