Scripting/SPublicRegion

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)