Interface IPartyList

This collection represents the actors present in your party or alliance.

Assembly: Dalamud.dll

Declaration

public interface IPartyList : IDalamudService, IReadOnlyCollection<IPartyMember>, IEnumerable<IPartyMember>, IEnumerable

Properties

Length

Gets the amount of party members the local player has.

Declaration

int Length { get; }

PartyLeaderIndex

Gets the index of the party leader.

Declaration

uint PartyLeaderIndex { get; }

IsAlliance

Gets a value indicating whether this group is an alliance.

Declaration

bool IsAlliance { get; }

GroupManagerAddress

Gets the address of the Group Manager.

Declaration

nint GroupManagerAddress { get; }

GroupListAddress

Gets the address of the party list within the group manager.

Declaration

nint GroupListAddress { get; }

AllianceListAddress

Gets the address of the alliance member list within the group manager.

Declaration

nint AllianceListAddress { get; }

PartyId

Gets the ID of the party.

Declaration

long PartyId { get; }

this[int]

Get a party member at the specified spawn index.

Declaration

IPartyMember? this[int index] { get; }

Methods

GetPartyMemberAddress(int)

Gets the address of the party member at the specified index of the party list.

Declaration

nint GetPartyMemberAddress(int index)

Returns

System.IntPtr: The memory address of the party member.

Parameters

Type	Name	Description
System.Int32	index	The index of the party member.

CreatePartyMemberReference(nint)

Create a reference to an FFXIV party member.

Declaration

IPartyMember? CreatePartyMemberReference(nint address)

Returns

Dalamud.Game.ClientState.Party.IPartyMember: The party member object containing the requested data.

Parameters

Type	Name	Description
System.IntPtr	address	The address of the party member in memory.

GetAllianceMemberAddress(int)

Gets the address of the alliance member at the specified index of the alliance list.

Declaration

nint GetAllianceMemberAddress(int index)

Returns

System.IntPtr: The memory address of the alliance member.

Parameters

Type	Name	Description
System.Int32	index	The index of the alliance member.

CreateAllianceMemberReference(nint)

Create a reference to an FFXIV alliance member.

Declaration

IPartyMember? CreateAllianceMemberReference(nint address)

Returns

Dalamud.Game.ClientState.Party.IPartyMember: The party member object containing the requested data.

Parameters

Type	Name	Description
System.IntPtr	address	The address of the alliance member in memory.