wiki.sine.space | sinespace

Difference between revisions of "Scripting/SGroup"

From wiki.sine.space
Jump to: navigation, search
Line 24: Line 24:
 
}}
 
}}
  
{{ScriptFunction|void|JoinGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Shows player a prompt to join specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)|5=<pre>Space.Groups.JoinGroup(675)</pre>|6=<pre></pre>
+
{{ScriptFunction|void|JoinGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Shows player a prompt to join specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)|5=<pre>Space.Groups.JoinGroup(675)</pre>|6=<pre>--Clicking this object will check if player is in group 350
 +
--and will prompt the player to leave if they are a member
 +
--and will prompt them to join if they are not a member
 +
thisObject = Space.Host.ExecutingObject
 +
 
 +
OnClickFunction = function()
 +
  if Space.Groups.IsMemberOf(350) then
 +
  Space.Groups.LeaveGroup(350)
 +
  else
 +
  Space.Groups.JoinGroup(350)
 +
  end
 +
end
 +
 
 +
 
 +
thisObject.AddClickable()
 +
thisObject.Clickable.OnClick(OnClickFunction)</pre>
 
}}
 
}}
  
{{ScriptFunction|void|LeaveGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Shows player a prompt to leave specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)|5=<pre>Space.Groups.LeaveGroup(675)</pre>|6=<pre></pre>  
+
{{ScriptFunction|void|LeaveGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Shows player a prompt to leave specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)|5=<pre>Space.Groups.LeaveGroup(675)</pre>|6=<pre>--Clicking this object will check if player is in group 350
 +
--and will prompt the player to leave if they are a member
 +
--and will prompt them to join if they are not a member
 +
thisObject = Space.Host.ExecutingObject
 +
 
 +
OnClickFunction = function()
 +
  if Space.Groups.IsMemberOf(350) then
 +
  Space.Groups.LeaveGroup(350)
 +
  else
 +
  Space.Groups.JoinGroup(350)
 +
  end
 +
end
 +
 
 +
 
 +
thisObject.AddClickable()
 +
thisObject.Clickable.OnClick(OnClickFunction)</pre>  
 
}}
 
}}
  

Revision as of 22:03, 5 January 2022

Members

IsMemberOf

bool IsMemberOf (int groupID)

Whether is a member of this group.

IsMember = Space.Groups.IsMemberOf(675)


--Clicking this object will check if player is a member of group with ID 350
--and it will turn green if you are, or red turn if you are not
thisObject = Space.Host.ExecutingObject


OnClickFunction = function()
  if Space.Groups.IsMemberOf(350) then
  thisObject.Renderer.Material.SetColor("_Color", Color.Green)
  else
  thisObject.Renderer.Material.SetColor("_Color", Color.Red)
  end
end


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

GetGroupInfo

SGroupInfo GetGroupInfo (int groupID)

Get the group info by groupID.

groupInfo = Space.Groups.GetGroupInfo(675)


JoinGroup

void JoinGroup (int groupID, bool force = false)

Shows player a prompt to join specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)

Space.Groups.JoinGroup(675)


--Clicking this object will check if player is in group 350 
--and will prompt the player to leave if they are a member
--and will prompt them to join if they are not a member
thisObject = Space.Host.ExecutingObject

OnClickFunction = function()
  if Space.Groups.IsMemberOf(350) then
  Space.Groups.LeaveGroup(350)
  else
  Space.Groups.JoinGroup(350)
  end
end


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

LeaveGroup

void LeaveGroup (int groupID, bool force = false)

Shows player a prompt to leave specified group. If force is true, the user will not be shown a prompt. (force parameter is white-label only)

Space.Groups.LeaveGroup(675)


--Clicking this object will check if player is in group 350 
--and will prompt the player to leave if they are a member
--and will prompt them to join if they are not a member
thisObject = Space.Host.ExecutingObject

OnClickFunction = function()
  if Space.Groups.IsMemberOf(350) then
  Space.Groups.LeaveGroup(350)
  else
  Space.Groups.JoinGroup(350)
  end
end


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


Properties

Membership

SGroupInfo Membership { get; }

Return an array with all the groups this player is a member of

groups = Space.Groups.Membership