Groups System¶
Note
These Docs are WIP and will be updated with Visual Blueprint Examples. Please see Class Methods for visual examples.
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:
Creating a Group¶
To create a new group:
- Get the GameFuse Groups subsystem
- Create a new Group structure
- Set properties like Name, Group Type, Max Group Size, etc.
- Call CreateGroup with the group data
- Create a callback function to handle the response
- Process the created group data
Fetching a Group¶
To fetch a specific group:
- Get the GameFuse Groups subsystem
- Call FetchGroup with the group ID
- Create a callback function to handle the response
- Process the group data for display
Fetching All Groups¶
To fetch all groups:
- Get the GameFuse Groups subsystem
- Call FetchAllGroups
- Create a callback function to handle the response
- Process the array of groups for display
Joining a Group¶
To join a group:
- Get the GameFuse Groups subsystem
- Call JoinGroup with the group ID
- Create a callback function to handle the response
- Process the success or failure of joining the group
Requesting to Join a Group¶
To request to join an invite-only group:
- Get the GameFuse Groups subsystem
- Call RequestToJoinGroup with the group ID
- Create a callback function to handle the response
- Process the success or failure of the join request
Accepting Join Requests¶
To accept a join request:
- Get the GameFuse Groups subsystem
- Call AcceptJoinRequest with the group ID and user ID
- Create a callback function to handle the response
- Process the success or failure of accepting the join request
Declining Join Requests¶
To decline a join request:
- Get the GameFuse Groups subsystem
- Call DeclineJoinRequest with the group ID and user ID
- Create a callback function to handle the response
- Process the success or failure of declining the join request
Leaving a Group¶
To leave a group:
- Get the GameFuse Groups subsystem
- Call LeaveGroup with the group ID
- Create a callback function to handle the response
- Process the success or failure of leaving the group
Deleting a Group¶
To delete a group:
- Get the GameFuse Groups subsystem
- Call DeleteGroup with the group ID
- Create a callback function to handle the response
- Process the success or failure of deleting the group
Fetching User Groups¶
To fetch user's groups:
- Get the GameFuse Groups subsystem
- Call FetchUserGroups
- Create a callback function to handle the response
- Process the user's groups for display
Searching for Groups¶
To search for groups:
- Get the GameFuse Groups subsystem
- Call SearchGroups with the search query
- Create a callback function to handle the response
- Process the search results for display
Managing Group Admins¶
To add an admin to a group:
- Get the GameFuse Groups subsystem
- Call AddAdmin with the group ID and user ID
- Create a callback function to handle the response
- Process the success or failure of adding the admin
To remove an admin from a group:
- Get the GameFuse Groups subsystem
- Call RemoveAdmin with the group ID and user ID
- Create a callback function to handle the response
- Process the success or failure of removing the admin
Managing Group Attributes¶
To add an attribute to a group:
- Get the GameFuse Groups subsystem
- Call AddAttribute with the group ID, key, and value
- Create a callback function to handle the response
- Process the success or failure of adding the attribute
To update an attribute:
- Get the GameFuse Groups subsystem
- Call UpdateAttribute with the group ID, key, and new value
- Create a callback function to handle the response
- Process the success or failure of updating the attribute
To remove an attribute:
- Get the GameFuse Groups subsystem
- Call RemoveAttribute with the group ID and key
- Create a callback function to handle the response
- Process the success or failure of removing the attribute