All pages
Powered by GitBook
1 of 1

Loading...

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 (This is the same information in the "Region List" window).

Parameter
Type
Description

GetRegionTexture

void GetRegionTexture (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 object to identify which region. (white-label grids only)

Parameter
Type
Description

GetOutfits

void GetOutfits (Closure onComplete)

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

Parameter
Type
Description

Properties

IsWhiteLabel

bool IsWhiteLabel get

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

PlayerIsAdmin

bool PlayerIsAdmin get

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

PlayerIsModerator

bool PlayerIsModerator get

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

PlayerIsDeveloper

bool PlayerIsDeveloper get

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

PlayerIsTrusted

bool PlayerIsTrusted get

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

ThemeColor1

ThemeColor1 get

The viewer's Theme Color 1.

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

ThemeColor2

ThemeColor2 get

The viewer's Theme Color 2.

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

ThemeColor3

ThemeColor3 get

The viewer's Theme Color 3.

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

ThemeColor4

ThemeColor4 get

The viewer's Theme Color 4.

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

TextColor1

TextColor1 get

The viewer's Text Color 1.

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

TextColor2

TextColor2 get

The viewer's Text Color 2.

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

Name

string Name get

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

SiteURL

string SiteURL get

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

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)

Avatars

int[] Avatars get

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

OrientationRegion

int OrientationRegion get

Returns the Region ID of the "Orientation Region".

SColor get

string get

string get

int get

int[] get

int get

void GetEnabledUserRegions (Closure onComplete)

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

void GetOutfits (Closure onComplete)

bool IsWhiteLabel get

bool PlayerIsAdmin get

bool PlayerIsModerator get

bool PlayerIsDeveloper get

bool PlayerIsTrusted get

SColor ThemeColor1 get

SColor ThemeColor2 get

SColor ThemeColor3 get

SColor ThemeColor4 get

onComplete

Closure (Callback)

onComplete is a function that will be called on completion with SUserRegions as a parameter. onComplete(SUserRegions)

onComplete

Closure (Callback)

onComplete is a function that will be called on completion with a List of SOutfit as a parameter.

SUserRegions.
SPublicRegion
SPublicRegion
SOutfit
SColor
SColor
SColor
SColor
SColor
SColor

SColor get

function GetUserRegionsComplete(SUserRegions)
--
end
Space.Grid.GetEnabledUserRegions(GetUserRegionsComplete)
--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)
Space.Grid.GetRegionTexture(AnSPublicRegionObject,OnCompleteFunction)
--see below example
--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)
function OnGetOutfitsComplete(TableSOutfits)
--
end
Space.Grid.GetOutfits(OnGetOutfitsComplete)
isWhiteLabel = Space.Grid.IsWhiteLabel
--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)
isAdmin = Space.Grid.PlayerIsAdmin
--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)
isModerator = Space.Grid.PlayerIsModerator
--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)
isDeveloper = Space.Grid.PlayerIsDeveloper
--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)
isTrusted = Space.Grid.PlayerIsTrusted
--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 = Space.Grid.ThemeColor1
themeColor2 = Space.Grid.ThemeColor2
themeColor3 = Space.Grid.ThemeColor3
themeColor4 = Space.Grid.ThemeColor4
textColor1 = Space.Grid.TextColor1
textColor2 = Space.Grid.TextColor2
gridName = Space.Grid.Name
--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 = Space.Grid.SiteURL
--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 = Space.Grid.DefaultRegion
--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 = Space.Grid.Avatars
--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 = Space.Grid.OrientationRegion
--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)
TextColor1
TextColor2
Name
SiteURL
DefaultRegion
Avatars
OrientationRegion