Groups

Groups are persistent bands of survivors that players found themselves. They replace gangs: EndCore has no gang system. A group has a name, a short tag, a roster and ranks, and it survives restarts. Players manage their group from the en-party menu or with the /group command.

#How groups work

• Membership belongs to a character (citizenid), not an account. A character can be in one group at a time.
• Groups are cached in memory at start and every change is written through to the database.
• The founder becomes the leader. The leader holds the highest rank and every permission.
• When a leader leaves, the highest-ranked member takes over (the earliest joiner wins a tie).
• A group with no members left is deleted.
• Deleting a character removes them from their group first, so leadership passes on properly.
• The player's state bag carries their group id: Player(source).state.group. It is replicated, so clients can read it too.

#Settings

Settings live in shared/groups.lua.

Default ranks:

#Rules

Founding a group

• The name must be 3–24 characters, start with a letter or digit, and contain only letters, digits, spaces, apostrophes and hyphens.
• The tag is uppercased and must be 2–4 letters or digits.
• Name and tag must both be unique.
• foundingCost is taken from the founder's cash and refunded if the group cannot be saved.

Ranks

• kick and promote only work on members ranked below you.
• You can only assign grades below your own.
• Only the leader can transfer leadership. The old leader drops one rank.

Invites

• Invites expire after inviteTimeout seconds.
• Pending invites are cleared when either player disconnects.

#Exports

Actions return true (sometimes with a result) or false, message. The message is written to be shown straight to the player.

GetGroupMembers is sorted by grade (highest first), then online members first, then by name.

The group summary is also attached to PlayerData.group at login. It is not stored on the character row.

#Callbacks

en-core registers two callbacks that the en-party group menu uses. You can use them to build your own group UI.

Actions for encore:groups:action:

See Callbacks for how to call them from the client.

#Commands

Kicking, changing ranks and transferring leadership are only in the en-party menu.

#Events

#Examples

Found a group from a custom NPC and show the error message if it fails:

local ok, result = exports['en-core']:CreateGroup(source, 'Dust Walkers', 'DUST')
if not ok then
    encore.notify(source, { description = result, type = 'error' })
end

No friendly fire between group members:

if exports['en-core']:AreInSameGroup(attacker, victim) then
    return
end

Message every online member of a player's group:

local group = exports['en-core']:GetPlayerGroup(source)
if group then
    for _, member in ipairs(exports['en-core']:GetOnlineGroupMembers(group.id)) do
        encore.notify(member, { description = ('[%s] Supply drop marked on your map.'):format(group.tag) })
    end
end

Show an invite prompt on the client:

RegisterNetEvent('encore:client:groupInvite', function(invite)
    print(('%s invited you to [%s] %s. Expires in %ds.'):format(invite.from, invite.tag, invite.name, invite.timeout))
end)

#Compatibility

QB scripts that read PlayerData.gang see the player's group presented as a gang when the QB bridge is active. See Compatibility bridges.

#Related

• en-party
• Skills and party
• Events