mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
739 lines
36 KiB
HTML
739 lines
36 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 PartyList
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class PartyList
|
|
">
|
|
<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.Party.PartyList">
|
|
|
|
|
|
<h1 id="Dalamud_Game_ClientState_Party_PartyList" data-uid="Dalamud.Game.ClientState.Party.PartyList" class="text-break">Class PartyList
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This collection represents the actors present in your party or alliance.</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">PartyList</span></div>
|
|
</div>
|
|
<div class="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Dalamud.IServiceType.html">IServiceType</a></div>
|
|
<div><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Dalamud.Game.ClientState.Party.PartyMember.html">PartyMember</a>></div>
|
|
<div><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Dalamud.Game.ClientState.Party.PartyMember.html">PartyMember</a>></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.Party.html">Dalamud.Game.ClientState.Party</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Game_ClientState_Party_PartyList_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class PartyList : IServiceType, IReadOnlyCollection<PartyMember>, IEnumerable<PartyMember>, 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_Party_PartyList_AllianceListAddress.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.AllianceListAddress%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/Party/PartyList.cs/#L64">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_AllianceListAddress_" data-uid="Dalamud.Game.ClientState.Party.PartyList.AllianceListAddress*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_AllianceListAddress" data-uid="Dalamud.Game.ClientState.Party.PartyList.AllianceListAddress">AllianceListAddress</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the alliance member list within the group manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr AllianceListAddress { 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_Party_PartyList_GroupListAddress.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.GroupListAddress%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/Party/PartyList.cs/#L59">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_GroupListAddress_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GroupListAddress*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_GroupListAddress" data-uid="Dalamud.Game.ClientState.Party.PartyList.GroupListAddress">GroupListAddress</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the party list within the group manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr GroupListAddress { 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_Party_PartyList_GroupManagerAddress.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.GroupManagerAddress%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/Party/PartyList.cs/#L54">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_GroupManagerAddress_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GroupManagerAddress*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_GroupManagerAddress" data-uid="Dalamud.Game.ClientState.Party.PartyList.GroupManagerAddress">GroupManagerAddress</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the Group Manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr GroupManagerAddress { 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_Party_PartyList_IsAlliance.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.IsAlliance%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/Party/PartyList.cs/#L49">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_IsAlliance_" data-uid="Dalamud.Game.ClientState.Party.PartyList.IsAlliance*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_IsAlliance" data-uid="Dalamud.Game.ClientState.Party.PartyList.IsAlliance">IsAlliance</h4>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether this group is an alliance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsAlliance { 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_Party_PartyList_Item_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.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/Party/PartyList.cs/#L80">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_Item_" data-uid="Dalamud.Game.ClientState.Party.PartyList.Item*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_Item_System_Int32_" data-uid="Dalamud.Game.ClientState.Party.PartyList.Item(System.Int32)">Item[Int32]</h4>
|
|
<div class="markdown level1 summary"><p>Get a party member 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 PartyMember 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.Party.PartyMember.html">PartyMember</a></td>
|
|
<td><p>A <a class="xref" href="Dalamud.Game.ClientState.Party.PartyMember.html">PartyMember</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_Party_PartyList_Length.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.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/Party/PartyList.cs/#L39">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_Length_" data-uid="Dalamud.Game.ClientState.Party.PartyList.Length*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_Length" data-uid="Dalamud.Game.ClientState.Party.PartyList.Length">Length</h4>
|
|
<div class="markdown level1 summary"><p>Gets the amount of party members 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_Party_PartyList_PartyId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.PartyId%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/Party/PartyList.cs/#L69">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_PartyId_" data-uid="Dalamud.Game.ClientState.Party.PartyList.PartyId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_PartyId" data-uid="Dalamud.Game.ClientState.Party.PartyList.PartyId">PartyId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the ID of the party.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public long PartyId { 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.Int64</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_Party_PartyList_PartyLeaderIndex.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.PartyLeaderIndex%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/Party/PartyList.cs/#L44">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_PartyLeaderIndex_" data-uid="Dalamud.Game.ClientState.Party.PartyList.PartyLeaderIndex*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_PartyLeaderIndex" data-uid="Dalamud.Game.ClientState.Party.PartyList.PartyLeaderIndex">PartyLeaderIndex</h4>
|
|
<div class="markdown level1 summary"><p>Gets the index of the party leader.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint PartyLeaderIndex { 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>
|
|
<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_Party_PartyList_CreateAllianceMemberReference_System_IntPtr_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.CreateAllianceMemberReference(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/Party/PartyList.cs/#L148">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_CreateAllianceMemberReference_" data-uid="Dalamud.Game.ClientState.Party.PartyList.CreateAllianceMemberReference*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_CreateAllianceMemberReference_System_IntPtr_" data-uid="Dalamud.Game.ClientState.Party.PartyList.CreateAllianceMemberReference(System.IntPtr)">CreateAllianceMemberReference(IntPtr)</h4>
|
|
<div class="markdown level1 summary"><p>Create a reference to an FFXIV alliance member.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public PartyMember CreateAllianceMemberReference(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 alliance member 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.Party.PartyMember.html">PartyMember</a></td>
|
|
<td><p>The party member 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_Party_PartyList_CreatePartyMemberReference_System_IntPtr_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.CreatePartyMemberReference(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/Party/PartyList.cs/#L119">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_CreatePartyMemberReference_" data-uid="Dalamud.Game.ClientState.Party.PartyList.CreatePartyMemberReference*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_CreatePartyMemberReference_System_IntPtr_" data-uid="Dalamud.Game.ClientState.Party.PartyList.CreatePartyMemberReference(System.IntPtr)">CreatePartyMemberReference(IntPtr)</h4>
|
|
<div class="markdown level1 summary"><p>Create a reference to an FFXIV party member.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public PartyMember CreatePartyMemberReference(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 party member 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.Party.PartyMember.html">PartyMember</a></td>
|
|
<td><p>The party member 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_Party_PartyList_GetAllianceMemberAddress_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.GetAllianceMemberAddress(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/Party/PartyList.cs/#L135">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_GetAllianceMemberAddress_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GetAllianceMemberAddress*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_GetAllianceMemberAddress_System_Int32_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GetAllianceMemberAddress(System.Int32)">GetAllianceMemberAddress(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the alliance member at the specified index of the alliance 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 GetAllianceMemberAddress(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 alliance member.</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 alliance member.</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_Party_PartyList_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.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/Party/PartyList.cs/#L169">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GetEnumerator*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_GetEnumerator" data-uid="Dalamud.Game.ClientState.Party.PartyList.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<PartyMember> 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><<a class="xref" href="Dalamud.Game.ClientState.Party.PartyMember.html">PartyMember</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_Party_PartyList_GetPartyMemberAddress_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.GetPartyMemberAddress(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/Party/PartyList.cs/#L106">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_GetPartyMemberAddress_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GetPartyMemberAddress*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_GetPartyMemberAddress_System_Int32_" data-uid="Dalamud.Game.ClientState.Party.PartyList.GetPartyMemberAddress(System.Int32)">GetPartyMemberAddress(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the party member at the specified index of the party 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 GetPartyMemberAddress(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 party member.</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 party member.</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_Party_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Party_PartyMember__Count.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.System%23Collections%23Generic%23IReadOnlyCollection%7BDalamud%23Game%23ClientState%23Party%23PartyMember%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/Party/PartyList.cs/#L166">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Party_PartyMember__Count_" data-uid="Dalamud.Game.ClientState.Party.PartyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Party#PartyMember}#Count*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Party_PartyMember__Count" data-uid="Dalamud.Game.ClientState.Party.PartyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Party#PartyMember}#Count">IReadOnlyCollection<PartyMember>.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<PartyMember>.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_Party_PartyList_System_Collections_IEnumerable_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList.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/Party/PartyList.cs/#L184">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Party_PartyList_System_Collections_IEnumerable_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Party.PartyList.System#Collections#IEnumerable#GetEnumerator*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Party_PartyList_System_Collections_IEnumerable_GetEnumerator" data-uid="Dalamud.Game.ClientState.Party.PartyList.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>
|
|
<a class="xref" href="Dalamud.IServiceType.html">IServiceType</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Collections.Generic.IReadOnlyCollection<T></span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Collections.Generic.IEnumerable<T></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_Party_PartyList.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Party.PartyList%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/Party/PartyList.cs/#L163" 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>
|