# SUserRegions

## Index

### Properties Index

| Property                                                         |
| ---------------------------------------------------------------- |
| int [**SubscriptionTier** ](#subscriptiontier)`get`              |
| int [**NumberOfRegions** ](#numberofregions)`get`                |
| int [**UsersPerRegion** ](#usersperregion)`get`                  |
| int [**FileSize** ](#filesize)`get`                              |
| string [**SubscriptionName** ](#subscriptionname)`get`           |
| SPublicRegion\[] [**AvailableRegions** ](#availableregions)`get` |

## Properties

### SubscriptionTier

int **SubscriptionTier** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}

### NumberOfRegions

int **NumberOfRegions** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}

### UsersPerRegion

int **UsersPerRegion** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}

### FileSize

int **FileSize** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}

### SubscriptionName

string **SubscriptionName** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}

### AvailableRegions

[SPublicRegion](https://docs.sine.space/scripting/client-scripting-api-reference/types/spublicregion)\[] **AvailableRegions** `get`

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

{% tabs %}
{% tab title="Lua" %}

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

{% endtab %}
{% endtabs %}