wiki.sine.space | sinespace

Difference between revisions of "Scripting/SGroup"

From wiki.sine.space
Jump to: navigation, search
(Created page with "==Members== {{ScriptFunction|bool|IsMemberOf|(int groupID)|Whether is a member of this group.|5= local group=Space.Groups<br> function Get()<br>     Space...")
 
Line 1: Line 1:
 
==Members==
 
==Members==
  
{{ScriptFunction|bool|IsMemberOf|(int groupID)|Whether is a member of this group.|5=
+
{{ScriptFunction|bool|IsMemberOf|(int groupID)|Whether is a member of this group.|5=<pre>
local group=Space.Groups<br>
+
IsMember = Space.Groups.IsMemberOf(675)</pre>|6=<pre></pre>
function Get()<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;Space.Log(group.IsMemberOf(675))<br>
+
end
+
 
}}
 
}}
  
{{ScriptFunction|SGroupInfo|GetGroupInfo|(int groupID)|Get the group info by groupID.|5=
+
{{ScriptFunction|SGroupInfo|GetGroupInfo|(int groupID)|Get the group info by groupID.|5=<pre>
local group=Space.Groups<br>
+
groupInfo = Space.Groups.GetGroupInfo(675)</pre>|6=<pre></pre>
function Get()<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;Space.Log(group.GetGroupInfo(675).Name)<br>
+
end
+
 
}}
 
}}
  
{{ScriptFunction|void|JoinGroup|(int groupID, bool force = false)|Join the group.|5=
+
{{ScriptFunction|void|JoinGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Join the group.|5=<pre>Space.Groups.JoinGroup(675)</pre>|6=<pre></pre>
local group=Space.Groups<br>
+
function Get()<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;group.JoinGroup(675)<br>
+
end
+
 
}}
 
}}
  
{{ScriptFunction|void|LeaveGroup|(int groupID, bool force = false)|Leave the group.|5=
+
{{ScriptFunction|void|LeaveGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Leave the group.|5=<pre>Space.Groups.LeaveGroup(675)</pre>|6=<pre></pre>  
local group=Space.Groups<br>
+
function Get()<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;group.group.LeaveGroup(675)<br>
+
end
+
 
}}
 
}}
  
Line 32: Line 18:
 
==Properties==
 
==Properties==
  
{{ScriptFunction|SGroupInfo|GetGroupInfo|(Membership)|Return an array of members from the group.|5=
+
 
local group=Space.Groups<br>
+
{{ScriptFunction|SGroupInfo|Membership|{ get; }|Return an array with all the groups this player is a member of|5=<pre>groups = Space.Groups.Membership</pre>|6=<pre></pre>}}
local members=group.Membership<br>
+
function Get()<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;for i=1, #members do<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Space.Log(members[i].Name)<br>
+
&nbsp;&nbsp;&nbsp;&nbsp;end<br>
+
end
+
}}
+
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 21:04, 5 January 2022

Members

IsMemberOf

bool IsMemberOf (int groupID)

Whether is a member of this group.

IsMember = Space.Groups.IsMemberOf(675)


GetGroupInfo

SGroupInfo GetGroupInfo (int groupID)

Get the group info by groupID.

groupInfo = Space.Groups.GetGroupInfo(675)


JoinGroup

void JoinGroup (int groupID, bool force = false)

Join the group.

Space.Groups.JoinGroup(675)


LeaveGroup

void LeaveGroup (int groupID, bool force = false)

Leave the group.

Space.Groups.LeaveGroup(675)



Properties

Membership

SGroupInfo Membership { get; }

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

groups = Space.Groups.Membership