Interface IBuddyList

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

Assembly: Dalamud.dll

View Source

Declaration

public interface IBuddyList : IReadOnlyCollection<IBuddyMember>, IEnumerable<IBuddyMember>, IEnumerable

Properties

Length

Gets the amount of battle buddies the local player has.

View Source

Declaration

int Length { get; }

CompanionBuddy

Gets the active companion buddy.

View Source

Declaration

IBuddyMember? CompanionBuddy { get; }

PetBuddy

Gets the active pet buddy.

View Source

Declaration

IBuddyMember? PetBuddy { get; }

this[int]

Gets a battle buddy at the specified spawn index.

View Source

Declaration

IBuddyMember? this[int index] { get; }

Methods

GetCompanionBuddyMemberAddress()

Gets the address of the companion buddy.

View Source

Declaration

nint GetCompanionBuddyMemberAddress()

Returns

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

GetPetBuddyMemberAddress()

Gets the address of the pet buddy.

View Source

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.

View Source

Declaration

nint GetBattleBuddyMemberAddress(int index)

Returns

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

Parameters

Type	Name	Description
System.Int32	index	The index of the battle buddy.

CreateBuddyMemberReference(nint)

Create a reference to a buddy.

View Source

Declaration

IBuddyMember? CreateBuddyMemberReference(nint address)

Returns

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

Parameters

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