Revision as of 22:42, 22 March 2022

Public Attributes

ID

int ID  

Returns the Region ID of this region

--Make's a UIText show the Region ID of the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.ID
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

OwnerID

int OwnerID  

Returns the ID of the owner of this region

--Make's a UIText show the OwnerID of the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.OwnerID
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Name

string Name '

Returns the Name of this region

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

MapPath

string MapPath  

PreviewPath

string PreviewPath  

RankingScore

int RankingScore  

Returns the Ranking Score of the region.

--Make's a UIText show the RankingScoreof the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.RankingScore
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

MaxAvatars

int MaxAvatars  

Returns the max number of avatars this region can hold.

--Make's a UIText show the MaxAvatars of the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.MaxAvatars
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

FileSize

int FileSize  

Returns the current MBs the region is using.

--Make's a UIText show the File Size of the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.FileSize
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Memory

int Memory  

Landmarks

[[Scripting/SLandmark[]|SLandmark[]]] Landmarks  

Returns an array of Landmarks in the region.

Regions

[[Scripting/SSubRegion[]|SSubRegion[]]] Regions  

Returns an array of Subregions in the region.

Description

string Description  

Returns the description of the region.

--Make's a UIText show the Descriptionof the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.Description
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Properties

Access

SAccessType Access { get; }

Returns the access type of the region (such as "Public" or "Approved only")

--Make's a UIText show the Access type of the user's first available region

textObject = Space.Host.GetReference("TheTextReference")

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  textObject.UIText.Text = r.Access
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

@@ Line 1: / Line 1: @@
 =Public Attributes=
-{{ScriptFunction|int|ID|{ get;set; }| |5=|6=<pre></pre>}}
+{{ScriptFunction|int|ID| | Returns the Region ID of this region|5=|6=<pre>--Make's a UIText show the Region ID of the user's first available region
-{{ScriptFunction|int|OwnerID|{ get;set; }| |5=|6=<pre></pre>}}
+textObject = Space.Host.GetReference("TheTextReference")
-{{ScriptFunction|string|Name|{ get;set; }| |5=|6=<pre></pre>}}
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.ID
+end
-{{ScriptFunction|string|MapPath|{ get;set; }| |5=|6=<pre></pre>}}
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
-{{ScriptFunction|void|PreviewPath|{ get;set; }| |5=|6=<pre></pre>}}
+{{ScriptFunction|int|OwnerID| |Returns the ID of the owner of this region |5=|6=<pre>--Make's a UIText show the OwnerID of the user's first available region
-{{ScriptFunction|int|RankingScore|{ get;set; }| |5=|6=<pre></pre>}}
+textObject = Space.Host.GetReference("TheTextReference")
-{{ScriptFunction|int|MaxAvatars|{ get;set; }| |5=|6=<pre></pre>}}
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.OwnerID
+end
-{{ScriptFunction|int|FileSize|{ get;set; }| |5=|6=<pre></pre>}}
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
-{{ScriptFunction|int|Memory|{ get;set; }| |5=|6=<pre></pre>}}
+{{ScriptFunction|string|Name||Returns the Name of this region |5=|6=<pre>--Make's a UIText show the Name of the user's first available region
-{{ScriptFunction|void|Landmarks|{ get;set; }| |5=|6=<pre></pre>}}
+textObject = Space.Host.GetReference("TheTextReference")
-{{ScriptFunction|void|Regions|{ get;set; }| |5=|6=<pre></pre>}}
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.Name
+end
-{{ScriptFunction|string|Description|{ get;set; }| |5=|6=<pre></pre>}}
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+{{ScriptFunction|string|MapPath| | |5=|6=<pre></pre>}}
+{{ScriptFunction|string|PreviewPath| | |5=|6=<pre></pre>}}
+{{ScriptFunction|int|RankingScore| |Returns the Ranking Score of the region. |5=|6=<pre>--Make's a UIText show the RankingScoreof the user's first available region
+textObject = Space.Host.GetReference("TheTextReference")
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.RankingScore
+end
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+{{ScriptFunction|int|MaxAvatars| |Returns the max number of avatars this region can hold. |5=|6=<pre>--Make's a UIText show the MaxAvatars of the user's first available region
+textObject = Space.Host.GetReference("TheTextReference")
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.MaxAvatars
+end
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+{{ScriptFunction|int|FileSize| |Returns the current MBs the region is using. |5=|6=<pre>--Make's a UIText show the File Size of the user's first available region
+textObject = Space.Host.GetReference("TheTextReference")
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.FileSize
+end
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+{{ScriptFunction|int|Memory| | |5=|6=<pre></pre>}}
+{{ScriptFunction|SLandmark[]|Landmarks| |Returns an array of Landmarks in the region. |5=|6=<pre></pre>}}
+{{ScriptFunction|SSubRegion[]|Regions| |Returns an array of Subregions in the region. |5=|6=<pre></pre>}}
+{{ScriptFunction|string|Description| |Returns the description of the region. |5=|6=<pre>--Make's a UIText show the Descriptionof the user's first available region
+textObject = Space.Host.GetReference("TheTextReference")
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.Description
+end
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
 =Properties=
-{{ScriptFunction|SAccessType|Access|{ get; }| |5=|6=<pre></pre>}}
+{{ScriptFunction|SAccessType|Access|{ get; }|Returns the access type of the region (such as "Public" or "Approved only")|5=|6=<pre>--Make's a UIText show the Access type of the user's first available region
+textObject = Space.Host.GetReference("TheTextReference")
+function GetUserRegionsComplete(SUserRegions)
+  local r = SUserRegions.AvailableRegions[1]
+  textObject.UIText.Text = r.Access
+end
+Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
 {{Scripting Navbox}}

Navigation

User Portal

Creation Portal

Tools

Difference between revisions of "Scripting/SPublicRegion"