Skip to main content

SPublicRegion

Index​

Properties Index​

Property
int ID get
int OwnerID get
string Name get
string MapPath get
string PreviewPath get
int RankingScore get
int MaxAvatars get
int FileSize get
int Memory get
SLandmark[] Landmarks get
SSubRegion[] Regions get
string Description get
SAccessType Access get

Properties​

ID​

int ID get

The Region ID of this region

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionID = r.ID
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

OwnerID​

int OwnerID get

The ID of the owner of this region

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionOwnerID = r.OwnerID
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Name​

string Name get

The Name of this region

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionName = r.Name
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

MapPath​

string MapPath get

Property Description

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionMapPath = r.MapPath
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

PreviewPath​

string PreviewPath get

Property Description

--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]
  regionPreviewPath = r.PreviewPath
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

RankingScore​

int RankingScore get

The Ranking Score of the region.

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionRankingScore = r.RankingScore
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

MaxAvatars​

int MaxAvatars get

The max number of avatars this region can hold.

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionMaxAvatars = r.MaxAvatars
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

FileSize​

int FileSize get

The current MBs the region is using.

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionFileSize = r.FileSize
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Memory​

int Memory get

Property Description

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionMemory = r.Memory
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Landmarks​

SLandmark[] Landmarks get

An array of Landmarks in the region.

``` function GetUserRegionsComplete(SUserRegions) local r = SUserRegions.AvailableRegions[1] regionLandmarks = r.Landmarks end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete) ```

Regions​

SSubRegion[] Regions get

Returns an array of SSubRegion in the region.

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
 regionSubRegions = r.Regions
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Description​

string Description get

Returns the description of the region.

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionDescription = r.Description
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Access​

int Access get

The access type of the region (such as "Public" or "Approved only")
1= Disabled, 2= FreeForall, 3= FriendsOnly, 4= ApprovedOnly, 5= GroupsOnly

function GetUserRegionsComplete(SUserRegions)
  local r = SUserRegions.AvailableRegions[1]
  regionAccessType = r.Access
end

Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)