Skip to main content
Version: 15.x (API 15) [Current]

Interface IBuddyList

This collection represents the buddies present in your squadron or trust party. It does not include the local player.

Assembly: Dalamud.dll​
Declaration
public interface IBuddyList : IDalamudService, IReadOnlyCollection<IBuddyMember>, IEnumerable<IBuddyMember>, IEnumerable

Properties​

Length​

Gets the amount of battle buddies the local player has.

Declaration
int Length { get; }

CompanionBuddy​

Gets the active companion buddy.

Declaration
IBuddyMember? CompanionBuddy { get; }

PetBuddy​

Gets the active pet buddy.

Declaration
IBuddyMember? PetBuddy { get; }

this[int]​

Gets a battle buddy at the specified spawn index.

Declaration
IBuddyMember? this[int index] { get; }

Methods​

GetCompanionBuddyMemberAddress()​

Gets the address of the companion buddy.

Declaration
nint GetCompanionBuddyMemberAddress()
Returns​

System.IntPtr: The memory address of the companion buddy.

GetPetBuddyMemberAddress()​

Gets the address of the pet buddy.

Declaration
nint GetPetBuddyMemberAddress()
Returns​

System.IntPtr: The memory address of the pet buddy.

GetBattleBuddyMemberAddress(int)​

Gets the address of the battle buddy at the specified index of the buddy list.

Declaration
nint GetBattleBuddyMemberAddress(int index)
Returns​

System.IntPtr: The memory address of the battle buddy.

Parameters​
TypeNameDescription
System.Int32indexThe index of the battle buddy.

CreateBuddyMemberReference(nint)​

Create a reference to a buddy.

Declaration
IBuddyMember? CreateBuddyMemberReference(nint address)
Returns​

Dalamud.Game.ClientState.Buddy.IBuddyMember: Dalamud.Game.ClientState.Buddy.BuddyMember object containing the requested data.

Parameters​
TypeNameDescription
System.IntPtraddressThe address of the buddy in memory.