ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Game.ClientState.Buddy.BuddyList.html
goaaats a3686d9c93
docs: regenerate
2022-01-29 05:15:26 +01:00

638 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BuddyList
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BuddyList
">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList">
<h1 id="Dalamud_Game_ClientState_Buddy_BuddyList" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList" class="text-break">Class BuddyList
</h1>
<div class="markdown level0 summary"><p>This collection represents the buddies present in your squadron or trust party.
It does not include the local player.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">BuddyList</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a>&gt;</div>
<div><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a>&gt;</div>
<div><span class="xref">System.Collections.IEnumerable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.Buddy.html">Dalamud.Game.ClientState.Buddy</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_ClientState_Buddy_BuddyList_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class BuddyList : IReadOnlyCollection&lt;BuddyMember&gt;, IEnumerable&lt;BuddyMember&gt;, IEnumerable</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddy.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L68">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddy_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddy*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddy" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddy">CompanionBuddy</h4>
<div class="markdown level1 summary"><p>Gets the active companion buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BuddyMember CompanionBuddy { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddyPresent.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddyPresent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L58">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddyPresent_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddyPresent*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_CompanionBuddyPresent" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CompanionBuddyPresent">CompanionBuddyPresent</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the local player's companion is present.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool CompanionBuddyPresent { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_Item_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.Item(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L103">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_Item_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.Item*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_Item_System_Int32_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.Item(System.Int32)">Item[Int32]</h4>
<div class="markdown level1 summary"><p>Gets a battle buddy at the specified spawn index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BuddyMember this[int index] { get; }</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>Spawn index.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a></td>
<td><p>A <a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a> at the specified spawn index.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_Length.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.Length%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L38">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_Length_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.Length*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_Length" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.Length">Length</h4>
<div class="markdown level1 summary"><p>Gets the amount of battle buddies the local player has.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Length { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddy.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L80">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddy_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddy*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddy" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddy">PetBuddy</h4>
<div class="markdown level1 summary"><p>Gets the active pet buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BuddyMember PetBuddy { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddyPresent.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddyPresent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L63">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddyPresent_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddyPresent*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_PetBuddyPresent" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.PetBuddyPresent">PetBuddyPresent</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the local player's pet is present.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool PetBuddyPresent { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_CreateBuddyMemberReference_System_IntPtr_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.CreateBuddyMemberReference(System.IntPtr)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L148">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_CreateBuddyMemberReference_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CreateBuddyMemberReference*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_CreateBuddyMemberReference_System_IntPtr_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.CreateBuddyMemberReference(System.IntPtr)">CreateBuddyMemberReference(IntPtr)</h4>
<div class="markdown level1 summary"><p>Create a reference to a buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BuddyMember CreateBuddyMemberReference(IntPtr address)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><span class="parametername">address</span></td>
<td><p>The address of the buddy in memory.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a></td>
<td><p><a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a> object containing the requested data.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_GetBattleBuddyMemberAddress_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.GetBattleBuddyMemberAddress(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L135">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_GetBattleBuddyMemberAddress_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetBattleBuddyMemberAddress*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_GetBattleBuddyMemberAddress_System_Int32_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetBattleBuddyMemberAddress(System.Int32)">GetBattleBuddyMemberAddress(Int32)</h4>
<div class="markdown level1 summary"><p>Gets the address of the battle buddy at the specified index of the buddy list.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GetBattleBuddyMemberAddress(int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index of the battle buddy.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>The memory address of the battle buddy.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_GetCompanionBuddyMemberAddress.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.GetCompanionBuddyMemberAddress%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L116">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_GetCompanionBuddyMemberAddress_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetCompanionBuddyMemberAddress*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_GetCompanionBuddyMemberAddress" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetCompanionBuddyMemberAddress">GetCompanionBuddyMemberAddress()</h4>
<div class="markdown level1 summary"><p>Gets the address of the companion buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GetCompanionBuddyMemberAddress()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>The memory address of the companion buddy.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_GetEnumerator.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.GetEnumerator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L175">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetEnumerator*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_GetEnumerator" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetEnumerator">GetEnumerator()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerator&lt;BuddyMember&gt; GetEnumerator()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerator</span>&lt;<a class="xref" href="Dalamud.Game.ClientState.Buddy.BuddyMember.html">BuddyMember</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_GetPetBuddyMemberAddress.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.GetPetBuddyMemberAddress%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L125">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_GetPetBuddyMemberAddress_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetPetBuddyMemberAddress*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_GetPetBuddyMemberAddress" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.GetPetBuddyMemberAddress">GetPetBuddyMemberAddress()</h4>
<div class="markdown level1 summary"><p>Gets the address of the pet buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GetPetBuddyMemberAddress()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>The memory address of the pet buddy.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="eii">Explicit Interface Implementations
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Buddy_BuddyMember__Count.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.System%23Collections%23Generic%23IReadOnlyCollection%7BDalamud%23Game%23ClientState%23Buddy%23BuddyMember%7D%23Count%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L172">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Buddy_BuddyMember__Count_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Buddy#BuddyMember}#Count*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Buddy_BuddyMember__Count" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Buddy#BuddyMember}#Count">IReadOnlyCollection&lt;BuddyMember&gt;.Count</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int IReadOnlyCollection&lt;BuddyMember&gt;.Count { get; }</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_IEnumerable_GetEnumerator.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList.System%23Collections%23IEnumerable%23GetEnumerator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L184">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_IEnumerable_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.System#Collections#IEnumerable#GetEnumerator*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyList_System_Collections_IEnumerable_GetEnumerator" data-uid="Dalamud.Game.ClientState.Buddy.BuddyList.System#Collections#IEnumerable#GetEnumerator">IEnumerable.GetEnumerator()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IEnumerator IEnumerable.GetEnumerator()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.IEnumerator</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.Collections.Generic.IReadOnlyCollection&lt;T&gt;</span>
</div>
<div>
<span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;</span>
</div>
<div>
<span class="xref">System.Collections.IEnumerable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Buddy_BuddyList.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyList%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Buddy/BuddyList.cs/#L169" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink