wiki.sine.space | sinespace

Difference between revisions of "Scripting/SPublicRegion"

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/spublicregion")
 
Line 1: Line 1:
=Public Attributes=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/spublicregion
 
+
{{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
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.ID
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</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
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.OwnerID
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</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
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.Name
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|string|MapPath| | |5=|6=<pre>--Make's a UIText show the Map Path of the user's first available region
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.MapPath
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</pre>}}
+
 
+
{{ScriptFunction|string|PreviewPath| | |5=|6=<pre>--Make's a UIText show the Preview Path of the user's first available region
+
 
+
textObject = Space.Host.GetReference("TheTextReference")
+
 
+
function GetUserRegionsComplete(SUserRegions)
+
  local r = SUserRegions.AvailableRegions[1]
+
  textObject.UIText.Text = r.PreviewPath
+
end
+
 
+
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)</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; }|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}}
+

Latest revision as of 08:03, 19 September 2022

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