SGrid

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

GetEnabledUserRegions

void GetEnabledUserRegions (Closure onComplete)

Calling this function will asynchronously get and return information about this player's regions as SUserRegions. (This is the same information in the "Region List" window).

Parameter	Type	Description
onComplete	Closure (Callback)

Lua

function GetUserRegionsComplete(SUserRegions)
--
end
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)

Lua

--Make's a UIText show this Grid's 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)

GetRegionTexture

void GetRegionTexture (SPublicRegion region, Closure onComplete) void GetRegionTexture (string json, Closure onComplete)

Returns the Region Texture (the image seen while loading the region) as a resource. This function requires an SPublicRegion object to identify which region. (white-label grids only)

Parameter	Type	Description

Lua

Space.Grid.GetRegionTexture(AnSPublicRegionObject,OnCompleteFunction)
--see below example

Lua

--When this object is clicked, it's material becomes the Region Texture of the user's first region

thisObject = Space.Host.ExecutingObject

function GetTextureComplete(textureResource)
  thisObject.Renderer.Material.SetTexture("_MainTex",textureResource)
end

function GetUserRegionsComplete(SUserRegions)
  r = SUserRegions.AvailableRegions
  Space.Grid.GetRegionTexture(r[1],GetTextureComplete)
end

function OnClickFunction()
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

GetOutfits

void GetOutfits (Closure onComplete)

Calling this function will asynchronously get and return information about this player's outfits as a List of SOutfit.

Parameter	Type	Description
onComplete	Closure (Callback)

Lua

function OnGetOutfitsComplete(TableSOutfits)
--
end
Space.Grid.GetOutfits(OnGetOutfitsComplete)

Properties

IsWhiteLabel

bool IsWhiteLabel get

Returns true if this Grid is a white-label Grid.

Lua

isWhiteLabel = Space.Grid.IsWhiteLabel

Lua

--Clicking this object will turn it green color if this grid is white-label
--and will turn it red color if not

thisObject = Space.Host.ExecutingObject

function OnClickFunction()

  if Space.Grid.IsWhiteLabel then
    thisObject.Renderer.Material.SetColor("_Color",Color.Green)
  else
    thisObject.Renderer.Material.SetColor("_Color",Color.Red)
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

PlayerIsAdmin

bool PlayerIsAdmin get

Returns true if this player's Grid role is Admin.(white-label grid only)

Lua

isAdmin = Space.Grid.PlayerIsAdmin

Lua

--Clicking this object will turn it green color if your grid role is Admin
--and will turn it red color if not

thisObject = Space.Host.ExecutingObject

function OnClickFunction()

  if Space.Grid.PlayerIsAdmin then
    thisObject.Renderer.Material.SetColor("_Color",Color.Green)
  else
    thisObject.Renderer.Material.SetColor("_Color",Color.Red)
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

PlayerIsModerator

bool PlayerIsModerator get

Returns true if this player's Grid role is Moderator. (white-label grid only)

Lua

isModerator = Space.Grid.PlayerIsModerator

Lua

--Clicking this object will turn it green color if your grid role is Moderator
--and will turn it red color if not

thisObject = Space.Host.ExecutingObject

function OnClickFunction()

  if Space.Grid.PlayerIsModerator then
    thisObject.Renderer.Material.SetColor("_Color",Color.Green)
  else
    thisObject.Renderer.Material.SetColor("_Color",Color.Red)
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

PlayerIsDeveloper

bool PlayerIsDeveloper get

Returns true if this player's Grid role is Developer.(white-label grid only)

Lua

isDeveloper = Space.Grid.PlayerIsDeveloper

Lua

--Clicking this object will turn it green color if your grid role is Developer
--and will turn it red color if not

thisObject = Space.Host.ExecutingObject

function OnClickFunction()

  if Space.Grid.PlayerIsDeveloper then
    thisObject.Renderer.Material.SetColor("_Color",Color.Green)
  else
    thisObject.Renderer.Material.SetColor("_Color",Color.Red)
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

PlayerIsTrusted

bool PlayerIsTrusted get

Returns true if this player's Grid role is Trusted.(white-label grid only)

Lua

isTrusted = Space.Grid.PlayerIsTrusted

Lua

--Clicking this object will turn it green color if your grid role is Trusted
--and will turn it red color if not

thisObject = Space.Host.ExecutingObject

function OnClickFunction()

  if Space.Grid.PlayerIsTrusted then
    thisObject.Renderer.Material.SetColor("_Color",Color.Green)
  else
    thisObject.Renderer.Material.SetColor("_Color",Color.Red)
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

ThemeColor1

SColor ThemeColor1 get

The viewer's Theme Color 1.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

themeColor1 = Space.Grid.ThemeColor1

ThemeColor2

SColor ThemeColor2 get

The viewer's Theme Color 2.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

themeColor2 = Space.Grid.ThemeColor2

ThemeColor3

SColor ThemeColor3 get

The viewer's Theme Color 3.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

themeColor3 = Space.Grid.ThemeColor3

ThemeColor4

SColor ThemeColor4 get

The viewer's Theme Color 4.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

themeColor4 = Space.Grid.ThemeColor4

TextColor1

SColor TextColor1 get

The viewer's Text Color 1.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

textColor1 = Space.Grid.TextColor1

TextColor2

SColor TextColor2 get

The viewer's Text Color 2.

The viewer's theme consist of 4 Theme Colors and 2 Text Colors.

Lua

textColor2 = Space.Grid.TextColor2

Name

string Name get

Returns the Grid's Name. (white-label grid only)

Lua

gridName = Space.Grid.Name

Lua

--Clicking this object will populate a UIText field with the current Grid's Name
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("TheTextReference")


function OnClickFunction()
local gridName = Space.Grid.Name
textObject.UIText.Text = gridName
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction

SiteURL

string SiteURL get

Returns the Grid's Site URL. (white-label grid only)

Lua

siteUrl = Space.Grid.SiteURL

Lua

--Clicking this object will populate a UIText field with the current Grid's Site URL
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("TheTextReference")


function OnClickFunction()
local siteURL = Space.Grid.SiteURL
textObject.UIText.Text = siteURL
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction

DefaultRegion

int DefaultRegion get

Returns the Region ID of the Default Region. The Default Region is set in the grid's Dashboard. (white-label grid only)

Lua

defaultRegion = Space.Grid.DefaultRegion

Lua

--Clicking this object will teleport the user to the grid's Default Region
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  local defaultRegion = Space.Grid.DefaultRegion
  Space.PlayerAvatar.Teleport(defaultRegion)
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

Avatars

int[] Avatars get

Returns the IDs of all Avatars in the grid. (white-label grid only)

Lua

avatars = Space.Grid.Avatars

Lua

--Clicking this object will populate a UIText field with the current Grid's Avatars
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("TheTextReference")


function OnClickFunction()
  local avatars = Space.Grid.Avatars
  av = json.serialize(avatars)
  textObject.UIText.Text = av
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

OrientationRegion

int OrientationRegion get

Returns the Region ID of the "Orientation Region".

Lua

 orientationRegion = Space.Grid.OrientationRegion

Lua

--Clicking this object will teleport the user to the grid's Orientation Region
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  local orientationRegionRegion = Space.Grid.OrientationRegion
  Space.PlayerAvatar.Teleport(orientationRegion)
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)