SGroupInfo

Index

Properties Index

Property Name
int ID get
int OwnerID get
string Name get
string Description get
string Access get
string ImageUrl get
int MaxAvatars get
string Role get
string CreateDate get

Properties

ID

int ID get

The ID of the group.

Lua

ID = Space.Groups.GetGroupInfo(350).ID

OwnerID

int OwnerID get

The ID of the group's owner.

Lua

OwnerID = Space.Groups.GetGroupInfo(350).OwnerID

Lua

--Clicking this object will show canvas1 if you are a group's owner
--and will show canvas2 if you are not

thisObject = Space.Host.ExecutingObject

canvas1 = Space.Host.GetReference("canvas1")--Add this object with canvas as reference in Scripting Runtime
canvas2 = Space.Host.GetReference("canvas2")--Add this object with canvas as reference in Scripting Runtime


OnClickFunction = function()
  
local groupInfo = Space.Groups.GetGroupInfo(350)

  if groupInfo.OwnerID == Space.Scene.PlayerAvatar.ID then
    canvas1.Active = true
  else
    canvas2.Active = true
  end
  

end

Name

string Name get

The name of the group.

Lua

Name = Space.Groups.GetGroupInfo(350).Name

Lua

--Clicking this object will show group 355's Name on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
GroupInfo = Space.Groups.GetGroupInfo(350)

uiText.Text = GroupInfo.Name
end


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

Description

string Description get

The description of the group.

Lua

Description =Space.Groups.GetGroupInfo(350).Description

Lua

--Clicking this object will show group 355's Description on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
GroupInfo = Space.Groups.GetGroupInfo(350)

uiText.Text = GroupInfo.Description
end


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

Access

string Access get

The level of access the group has, e.g. public or private.

Lua

Access = Space.Groups.GetGroupInfo(350).Access

Lua

--Clicking this object will show group 355's Access on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
GroupInfo = Space.Groups.GetGroupInfo(350)

uiText.Text = GroupInfo.Access
end


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

ImageUrl

string ImageUrl get

The URL of the group's image.

Lua

ImageUrl = Space.Groups.GetGroupInfo(350).ImageUrl

Lua

--Clicking this object will show group 355's ImageUrl on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
GroupInfo = Space.Groups.GetGroupInfo(350)

uiText.Text = GroupInfo.ImageUrl
end


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

MaxAvatars

int MaxAvatars get

The max number of members the group can have.

Lua

MaxAvatars = Space.Groups.GetGroupInfo(350).MaxAvatars

Lua

--Clicking this object will show group 355's MaxAvatars on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
GroupInfo = Space.Groups.GetGroupInfo(350)

uiText.Text = GroupInfo.MaxAvatars
end


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

Role

string Role get

Player's role in this group.

Lua

Role = Space.Groups.GetGroupInfo(350).Role

Lua

--Clicking this object will show canvas1 if you are a  VIP in the group
--and will show canvas2 if you are a regular member
--and will show canvas3 if you are the group owner

thisObject = Space.Host.ExecutingObject

canvas1 = Space.Host.GetReference("canvas1")--Add this object with canvas as reference in Scripting Runtime
canvas2 = Space.Host.GetReference("canvas2")--Add this object with canvas as reference in Scripting Runtime
canvas3 = Space.Host.GetReference("canvas3")--Add this object with canvas as reference in Scripting Runtime

OnClickFunction = function()
  
local groupInfo = Space.Groups.GetGroupInfo(350)

  if groupInfo.Role == "Owner" then
  canvas3.Active = true
  elseif groupInfo.Role == "VIP" then
  canvas1.Active = true
  elseif groupInfo.Role == "Normal" then
  canvas2.Active = true
  end

end

CreateDate

string CreateDate get

Creation date of the group.

Lua

CreateDate = Space.Groups.GetGroupInfo(350).CreateDate

Lua

--Clicking this object will show group 355's creation date on a UIText object

thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime

OnClickFunction = function()
  
CreateDate = Space.Groups.GetGroupInfo(350).CreateDate

uiText.Text = CreateDate
end


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