wiki.sine.space | sinespace

Difference between revisions of "Scripting/SGroup"

From wiki.sine.space
Jump to: navigation, search
Line 9: Line 9:
 
}}
 
}}
  
{{ScriptFunction|void|JoinGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Join the group. (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></pre>
 
}}
 
}}
  
{{ScriptFunction|void|LeaveGroup|(int groupID, bool <nowiki>force = false</nowiki>)|Leave the group.(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></pre>  
 
}}
 
}}
  

Revision as of 21:22, 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)

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)


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)



Properties

Membership

SGroupInfo Membership { get; }

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

groups = Space.Groups.Membership