Skip to main content

SUserRegions

Index​

Properties Index​

Property
int SubscriptionTier get
int NumberOfRegions get
int UsersPerRegion get
int FileSize get
string SubscriptionName get
SPublicRegion[] AvailableRegions get

Properties​

SubscriptionTier​

int SubscriptionTier get

The subscription tier indicates which type of premium memberhsip the player has. (As found in "Region" window)

--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)

NumberOfRegions​

int NumberOfRegions get

The number of regions the player has. (As found in "Region" window)

--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)

UsersPerRegion​

int UsersPerRegion get

The max number of users allowed per region. ("Concurrency" as found in "Region" window).

--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)

FileSize​

int FileSize get

The maximum MB size the player's regions can be. ("Max Region SizE" in the "Region" window)

--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)

SubscriptionName​

string SubscriptionName get

The name of the current player's premium subscription (as found in "Region" window)

--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)

AvailableRegions​

SPublicRegion[] AvailableRegions get

Returns an array of SPublicRegion which is a group of data for each of the user's available regions.

--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)