Core Methods

Core methods are the primary functions for managing the party system.

Creating a Party

local party = PartySystem.new(leader: Player): Party

Creates a new party with the specified leader.

Example:

local leader = game.Players.Player1
local party = PartySystem.new(leader)
print("Party created with leader:", party.Leader.Name)

Getting Party Information

Get Party by Player

local party = PartySystem:GetParty(player: Player): Party | nil

Returns the party that the specified player belongs to, or nil if they're not in a party.

Example:

local player = game.Players.Player1
local party = PartySystem:GetParty(player)
if party then
    print(player.Name .. " is in party:", party.PartyName)
else
    print(player.Name .. " is not in a party.")
end

Get Party by ID

local party = PartySystem:GetPartyById(partyId: string): Party | nil

Finds and returns a party by its unique ID, or nil if not found.

Example:

local partyId = "12345"
local party = PartySystem:GetPartyById(partyId)
if party then
    print("Party found:", party.PartyName)
else
    print("No party found with ID:", partyId)
end

Get All Parties

local parties = PartySystem:GetAllParties(): {[string]: Party}

Returns a dictionary of all active parties, indexed by their IDs.

Example:

local parties = PartySystem:GetAllParties()
for partyId, party in pairs(parties) do
    print("Party ID:", partyId, "Party Name:", party.PartyName)
end