Dalamud/docs/api/Dalamud.Game.ClientState.Buddy.BuddyMember.html
2022-10-29 15:34:04 +02:00

440 lines
21 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BuddyMember
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BuddyMember
">
<meta name="generator" content="docfx 2.59.4.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.BuddyMember">
<h1 id="Dalamud_Game_ClientState_Buddy_BuddyMember" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember" class="text-break">Class BuddyMember
</h1>
<div class="markdown level0 summary"><p>This class represents a buddy such as the chocobo companion, summoned pets, squadron groups and trust parties.</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">BuddyMember</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_BuddyMember_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BuddyMember</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_BuddyMember_Address.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.Address%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/BuddyMember.cs/#L29">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_Address_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.Address*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_Address" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.Address">Address</h4>
<div class="markdown level1 summary"><p>Gets the address of the buddy in memory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr Address { 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.IntPtr</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_BuddyMember_CurrentHP.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.CurrentHP%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/BuddyMember.cs/#L47">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_CurrentHP_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.CurrentHP*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_CurrentHP" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.CurrentHP">CurrentHP</h4>
<div class="markdown level1 summary"><p>Gets the current health of this buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint CurrentHP { 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.UInt32</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_BuddyMember_DataID.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.DataID%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/BuddyMember.cs/#L57">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_DataID_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.DataID*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_DataID" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.DataID">DataID</h4>
<div class="markdown level1 summary"><p>Gets the data ID of this buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint DataID { 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.UInt32</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_BuddyMember_GameObject.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.GameObject%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/BuddyMember.cs/#L42">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_GameObject_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.GameObject*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_GameObject" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.GameObject">GameObject</h4>
<div class="markdown level1 summary"><p>Gets the actor associated with this buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public GameObject GameObject { 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.Objects.Types.GameObject.html">GameObject</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_ClientState_Buddy_BuddyMember_GameObject_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This iterates the actor table, it should be used with care.</p>
</div>
<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_BuddyMember_MaxHP.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.MaxHP%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/BuddyMember.cs/#L52">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_MaxHP_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.MaxHP*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_MaxHP" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.MaxHP">MaxHP</h4>
<div class="markdown level1 summary"><p>Gets the maximum health of this buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint MaxHP { 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.UInt32</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_BuddyMember_MountData.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.MountData%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/BuddyMember.cs/#L62">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_MountData_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.MountData*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_MountData" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.MountData">MountData</h4>
<div class="markdown level1 summary"><p>Gets the Mount data related to this buddy. It should only be used with companion buddies.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelResolver&lt;Mount&gt; MountData { 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.Resolvers.ExcelResolver-1.html">ExcelResolver</a>&lt;<span class="xref">Lumina.Excel.GeneratedSheets.Mount</span>&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_BuddyMember_ObjectId.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.ObjectId%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/BuddyMember.cs/#L34">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_ObjectId_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.ObjectId*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_ObjectId" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.ObjectId">ObjectId</h4>
<div class="markdown level1 summary"><p>Gets the object ID of this buddy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint ObjectId { 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.UInt32</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_BuddyMember_PetData.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.PetData%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/BuddyMember.cs/#L67">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_PetData_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.PetData*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_PetData" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.PetData">PetData</h4>
<div class="markdown level1 summary"><p>Gets the Pet data related to this buddy. It should only be used with pet buddies.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelResolver&lt;Pet&gt; PetData { 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.Resolvers.ExcelResolver-1.html">ExcelResolver</a>&lt;<span class="xref">Lumina.Excel.GeneratedSheets.Pet</span>&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_BuddyMember_TrustData.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember.TrustData%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/BuddyMember.cs/#L72">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Buddy_BuddyMember_TrustData_" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.TrustData*"></a>
<h4 id="Dalamud_Game_ClientState_Buddy_BuddyMember_TrustData" data-uid="Dalamud.Game.ClientState.Buddy.BuddyMember.TrustData">TrustData</h4>
<div class="markdown level1 summary"><p>Gets the Trust data related to this buddy. It should only be used with battle buddies.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelResolver&lt;DawnGrowMember&gt; TrustData { 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.Resolvers.ExcelResolver-1.html">ExcelResolver</a>&lt;<span class="xref">Lumina.Excel.GeneratedSheets.DawnGrowMember</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
</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_BuddyMember.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Buddy.BuddyMember%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/BuddyMember.cs/#L12" 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>