Groups System¶
The GameFuse Groups System allows you to create and manage groups of users in your game. This includes creating groups, joining groups, managing group membership, and handling group attributes.
Getting Started with Groups¶
To use the GameFuse Groups system in Blueprints, you'll need to access the GameFuse Groups subsystem through Get Game Instance → Get Subsystem → GameFuse Groups.
Creating a Group¶
You can create a new group with customizable properties:
Blueprint Example
Fetching Groups¶
Search/Fetch All Groups¶
Get all available groups or search for specific groups:
Blueprint Example
Fetch Specific Group¶
Get detailed information about a specific group:
Blueprint Example
Joining Groups¶
Join Public Groups¶
Join a public group directly:
Blueprint Example
Request to Join Private Groups¶
Request to join a private or invite-only group:
Blueprint Example
Managing Join Requests¶
Accept Join Requests¶
As a group admin, accept pending join requests:
Blueprint Example
Decline Join Requests¶
As a group admin, decline pending join requests:
Blueprint Example
Leaving Groups¶
Leave a group you're currently a member of:
Blueprint Example
Deleting Groups¶
As a group owner, delete a group:
Blueprint Example
Managing Group Admins¶
Add/Remove Group Admins¶
Manage administrative privileges within the group:
Blueprint Example
Managing Group Attributes¶
Set/Get Group Attributes¶
Store and retrieve custom data for groups:
Blueprint Example
Function Parameters¶
Create Group¶
Parameter | Type | Description |
---|---|---|
Group Name |
String |
The name of the group |
Group Type |
String |
Type: "public", "private", or "invite-only" |
Max Group Size |
Integer |
Maximum number of members (optional) |
Description |
String |
Group description (optional) |
Join/Leave/Delete Group¶
Parameter | Type | Description |
---|---|---|
Group ID |
Integer |
Unique identifier of the group |
Manage Members/Admins¶
Parameter | Type | Description |
---|---|---|
Group ID |
Integer |
Unique identifier of the group |
User ID |
Integer |
Unique identifier of the user |
Group Attributes¶
Parameter | Type | Description |
---|---|---|
Group ID |
Integer |
Unique identifier of the group |
Attribute Key |
String |
Name of the attribute |
Attribute Value |
String |
Value to store |
Function Return Values¶
Create Group¶
HTTP Status Code | Description |
---|---|
200 |
OK - Group created successfully |
400 |
Bad request - Invalid parameters |
401 |
Unauthorized - User not signed in |
409 |
Conflict - Group name already exists |
500 |
Unknown server error |
Join/Leave Group¶
HTTP Status Code | Description |
---|---|
200 |
OK - Action completed successfully |
400 |
Bad request - Invalid group ID |
401 |
Unauthorized - User not signed in |
403 |
Forbidden - Not allowed to perform action |
404 |
Group not found |
500 |
Unknown server error |
Manage Group¶
HTTP Status Code | Description |
---|---|
200 |
OK - Management action completed |
400 |
Bad request - Invalid parameters |
401 |
Unauthorized - User not signed in |
403 |
Forbidden - Insufficient permissions |
404 |
Group or user not found |
500 |
Unknown server error |
Data Structures¶
Group Struct¶
Property | Type | Description |
---|---|---|
ID |
Integer |
Unique group identifier |
Name |
String |
Group name |
Description |
String |
Group description |
Group Type |
String |
Type of group (public, private, invite-only) |
Max Group Size |
Integer |
Maximum number of members |
Current Size |
Integer |
Current number of members |
Owner ID |
Integer |
User ID of the group owner |
Created At |
String |
When the group was created |
Members |
Array |
List of group members |
Admins |
Array |
List of group administrators |
Group Member Struct¶
Property | Type | Description |
---|---|---|
User ID |
Integer |
Unique user identifier |
Username |
String |
User's display name |
Role |
String |
Member role (owner, admin, member) |
Joined At |
String |
When the user joined the group |
Next Steps¶
- Chat - Implement group chat functionality
- Friends - Invite friends to groups
- In Game Leaderboard - Create group leaderboards
- Custom User Data - Store group-related user data