mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
2518 lines
109 KiB
HTML
2518 lines
109 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 DalamudPluginInterface
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class DalamudPluginInterface
|
|
">
|
|
<meta name="generator" content="docfx 2.59.1.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.Plugin.DalamudPluginInterface">
|
|
|
|
|
|
<h1 id="Dalamud_Plugin_DalamudPluginInterface" data-uid="Dalamud.Plugin.DalamudPluginInterface" class="text-break">Class DalamudPluginInterface
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class acts as an interface to various objects needed to interact with Dalamud and the game.</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">DalamudPluginInterface</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">System.IDisposable</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.Plugin.html">Dalamud.Plugin</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Plugin_DalamudPluginInterface_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class DalamudPluginInterface : IDisposable</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_Plugin_DalamudPluginInterface_AssemblyLocation.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.AssemblyLocation%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/Plugin/DalamudPluginInterface.cs/#L122">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_AssemblyLocation_" data-uid="Dalamud.Plugin.DalamudPluginInterface.AssemblyLocation*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_AssemblyLocation" data-uid="Dalamud.Plugin.DalamudPluginInterface.AssemblyLocation">AssemblyLocation</h4>
|
|
<div class="markdown level1 summary"><p>Gets the location of your plugin assembly.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public FileInfo AssemblyLocation { 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.IO.FileInfo</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_Plugin_DalamudPluginInterface_ConfigDirectory.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.ConfigDirectory%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/Plugin/DalamudPluginInterface.cs/#L127">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_ConfigDirectory_" data-uid="Dalamud.Plugin.DalamudPluginInterface.ConfigDirectory*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_ConfigDirectory" data-uid="Dalamud.Plugin.DalamudPluginInterface.ConfigDirectory">ConfigDirectory</h4>
|
|
<div class="markdown level1 summary"><p>Gets the directory your plugin configurations are stored in.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DirectoryInfo ConfigDirectory { 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.IO.DirectoryInfo</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_Plugin_DalamudPluginInterface_ConfigFile.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.ConfigFile%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/Plugin/DalamudPluginInterface.cs/#L132">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_ConfigFile_" data-uid="Dalamud.Plugin.DalamudPluginInterface.ConfigFile*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_ConfigFile" data-uid="Dalamud.Plugin.DalamudPluginInterface.ConfigFile">ConfigFile</h4>
|
|
<div class="markdown level1 summary"><p>Gets the config file of your plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public FileInfo ConfigFile { 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.IO.FileInfo</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_Plugin_DalamudPluginInterface_DalamudAssetDirectory.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.DalamudAssetDirectory%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/Plugin/DalamudPluginInterface.cs/#L117">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_DalamudAssetDirectory_" data-uid="Dalamud.Plugin.DalamudPluginInterface.DalamudAssetDirectory*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_DalamudAssetDirectory" data-uid="Dalamud.Plugin.DalamudPluginInterface.DalamudAssetDirectory">DalamudAssetDirectory</h4>
|
|
<div class="markdown level1 summary"><p>Gets the directory Dalamud assets are stored in.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DirectoryInfo DalamudAssetDirectory { 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.IO.DirectoryInfo</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_Plugin_DalamudPluginInterface_GeneralChatType.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GeneralChatType%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/Plugin/DalamudPluginInterface.cs/#L161">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GeneralChatType_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GeneralChatType*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GeneralChatType" data-uid="Dalamud.Plugin.DalamudPluginInterface.GeneralChatType">GeneralChatType</h4>
|
|
<div class="markdown level1 summary"><p>Gets the chat type used by default for plugin messages.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public XivChatType GeneralChatType { 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.Text.XivChatType.html">XivChatType</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_Plugin_DalamudPluginInterface_IsDebugging.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.IsDebugging%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/Plugin/DalamudPluginInterface.cs/#L145">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_IsDebugging_" data-uid="Dalamud.Plugin.DalamudPluginInterface.IsDebugging*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_IsDebugging" data-uid="Dalamud.Plugin.DalamudPluginInterface.IsDebugging">IsDebugging</h4>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether Dalamud is running in Debug mode or the /xldev menu is open. This can occur on release builds.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsDebugging { 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_Plugin_DalamudPluginInterface_IsDev.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.IsDev%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/Plugin/DalamudPluginInterface.cs/#L97">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_IsDev_" data-uid="Dalamud.Plugin.DalamudPluginInterface.IsDev*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_IsDev" data-uid="Dalamud.Plugin.DalamudPluginInterface.IsDev">IsDev</h4>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether this is a dev plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsDev { 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_Plugin_DalamudPluginInterface_LoadTime.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LoadTime%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/Plugin/DalamudPluginInterface.cs/#L102">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_LoadTime_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTime*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LoadTime" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTime">LoadTime</h4>
|
|
<div class="markdown level1 summary"><p>Gets the time that this plugin was loaded.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DateTime LoadTime { 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.DateTime</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_Plugin_DalamudPluginInterface_LoadTimeDelta.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LoadTimeDelta%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/Plugin/DalamudPluginInterface.cs/#L112">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_LoadTimeDelta_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTimeDelta*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LoadTimeDelta" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTimeDelta">LoadTimeDelta</h4>
|
|
<div class="markdown level1 summary"><p>Gets the timespan delta from when this plugin was loaded.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TimeSpan LoadTimeDelta { 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.TimeSpan</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_Plugin_DalamudPluginInterface_LoadTimeUTC.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LoadTimeUTC%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/Plugin/DalamudPluginInterface.cs/#L107">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_LoadTimeUTC_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTimeUTC*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LoadTimeUTC" data-uid="Dalamud.Plugin.DalamudPluginInterface.LoadTimeUTC">LoadTimeUTC</h4>
|
|
<div class="markdown level1 summary"><p>Gets the UTC time that this plugin was loaded.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DateTime LoadTimeUTC { 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.DateTime</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_Plugin_DalamudPluginInterface_PluginInternalNames.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.PluginInternalNames%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/Plugin/DalamudPluginInterface.cs/#L171">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_PluginInternalNames_" data-uid="Dalamud.Plugin.DalamudPluginInterface.PluginInternalNames*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_PluginInternalNames" data-uid="Dalamud.Plugin.DalamudPluginInterface.PluginInternalNames">PluginInternalNames</h4>
|
|
<div class="markdown level1 summary"><p>Gets a list of installed plugin internal names.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public List<string> PluginInternalNames { 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.Collections.Generic.List</span><<span class="xref">System.String</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_Plugin_DalamudPluginInterface_PluginNames.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.PluginNames%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/Plugin/DalamudPluginInterface.cs/#L166">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_PluginNames_" data-uid="Dalamud.Plugin.DalamudPluginInterface.PluginNames*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_PluginNames" data-uid="Dalamud.Plugin.DalamudPluginInterface.PluginNames">PluginNames</h4>
|
|
<div class="markdown level1 summary"><p>Gets a list of installed plugin names.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public List<string> PluginNames { 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.Collections.Generic.List</span><<span class="xref">System.String</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_Plugin_DalamudPluginInterface_Reason.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Reason%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/Plugin/DalamudPluginInterface.cs/#L92">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Reason_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Reason*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Reason" data-uid="Dalamud.Plugin.DalamudPluginInterface.Reason">Reason</h4>
|
|
<div class="markdown level1 summary"><p>Gets the reason this plugin was loaded.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public PluginLoadReason Reason { 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.Plugin.PluginLoadReason.html">PluginLoadReason</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_Plugin_DalamudPluginInterface_Sanitizer.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Sanitizer%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/Plugin/DalamudPluginInterface.cs/#L156">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Sanitizer_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Sanitizer*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Sanitizer" data-uid="Dalamud.Plugin.DalamudPluginInterface.Sanitizer">Sanitizer</h4>
|
|
<div class="markdown level1 summary"><p>Gets serializer class with functions to remove special characters from strings.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ISanitizer Sanitizer { 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.Text.Sanitizer.ISanitizer.html">ISanitizer</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_Plugin_DalamudPluginInterface_UiBuilder.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.UiBuilder%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/Plugin/DalamudPluginInterface.cs/#L137">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_UiBuilder_" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiBuilder*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UiBuilder" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiBuilder">UiBuilder</h4>
|
|
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_UiBuilder">UiBuilder</a> instance which allows you to draw UI into the game via ImGui draw calls.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public UiBuilder UiBuilder { 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.Interface.UiBuilder.html">UiBuilder</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_Plugin_DalamudPluginInterface_UiLanguage.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.UiLanguage%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/Plugin/DalamudPluginInterface.cs/#L151">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_UiLanguage_" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiLanguage*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UiLanguage" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiLanguage">UiLanguage</h4>
|
|
<div class="markdown level1 summary"><p>Gets the current UI language in two-letter iso format.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string UiLanguage { 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.String</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_Plugin_DalamudPluginInterface_AddChatLinkHandler_System_UInt32_System_Action_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString__.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler(System.UInt32%2CSystem.Action%7BSystem.UInt32%2CDalamud.Game.Text.SeStringHandling.SeString%7D)%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/Plugin/DalamudPluginInterface.cs/#L323">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_AddChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_AddChatLinkHandler_System_UInt32_System_Action_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString__" data-uid="Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler(System.UInt32,System.Action{System.UInt32,Dalamud.Game.Text.SeStringHandling.SeString})">AddChatLinkHandler(UInt32, Action<UInt32, SeString>)</h4>
|
|
<div class="markdown level1 summary"><p>Register a chat link handler.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DalamudLinkPayload AddChatLinkHandler(uint commandId, Action<uint, SeString> commandAction)</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.UInt32</span></td>
|
|
<td><span class="parametername">commandId</span></td>
|
|
<td><p>The ID of the command.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span><<span class="xref">System.UInt32</span>, <a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a>></td>
|
|
<td><span class="parametername">commandAction</span></td>
|
|
<td><p>The action to be executed.</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.Text.SeStringHandling.Payloads.DalamudLinkPayload.html">DalamudLinkPayload</a></td>
|
|
<td><p>Returns an SeString payload for the link.</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_Plugin_DalamudPluginInterface_Create__1_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Create%60%601(System.Object%5B%5D)%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/Plugin/DalamudPluginInterface.cs/#L354">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Create_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Create*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Create__1_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.Create``1(System.Object[])">Create<T>(Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Create a new object of the provided type using its default constructor, then inject objects and properties.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public T Create<T>(params object[] scopedObjects)
|
|
where T : class</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.Object</span>[]</td>
|
|
<td><span class="parametername">scopedObjects</span></td>
|
|
<td><p>Objects to inject additionally.</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">T</span></td>
|
|
<td><p>The created and initialized type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T</span></td>
|
|
<td><p>The type to create.</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_Plugin_DalamudPluginInterface_Dispose.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Dispose%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/Plugin/DalamudPluginInterface.cs/#L398">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Dispose_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Dispose*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Dispose" data-uid="Dalamud.Plugin.DalamudPluginInterface.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Obsolete implicit dispose implementation. Should not be used.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("Do not dispose \"DalamudPluginInterface\".", true)]
|
|
public void Dispose()</code></pre>
|
|
</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_Plugin_DalamudPluginInterface_GetIpcProvider__1_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%601(System.String)%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/Plugin/DalamudPluginInterface.cs/#L182">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__1_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``1(System.String)">GetIpcProvider<TRet>(String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets an IPC provider.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ICallGateProvider<TRet> GetIpcProvider<TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>The name of the IPC registration.</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.Plugin.Ipc.ICallGateProvider-1.html">ICallGateProvider</a><TRet></td>
|
|
<td><p>An IPC provider.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TRet</span></td>
|
|
<td><p>The return type for funcs. Use object if this is unused.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Plugin.Ipc.Exceptions.IpcTypeMismatchError.html">IpcTypeMismatchError</a></td>
|
|
<td><p>This is thrown when the requested types do not match the previously registered types are different.</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_Plugin_DalamudPluginInterface_GetIpcProvider__2_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%602(System.String)%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/Plugin/DalamudPluginInterface.cs/#L186">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__2_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``2(System.String)">GetIpcProvider<T1, TRet>(String)</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 ICallGateProvider<T1, TRet> GetIpcProvider<T1, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-2.html">ICallGateProvider</a><T1, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__3_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%603(System.String)%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/Plugin/DalamudPluginInterface.cs/#L190">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__3_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``3(System.String)">GetIpcProvider<T1, T2, TRet>(String)</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 ICallGateProvider<T1, T2, TRet> GetIpcProvider<T1, T2, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-3.html">ICallGateProvider</a><T1, T2, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__4_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%604(System.String)%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/Plugin/DalamudPluginInterface.cs/#L194">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__4_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``4(System.String)">GetIpcProvider<T1, T2, T3, TRet>(String)</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 ICallGateProvider<T1, T2, T3, TRet> GetIpcProvider<T1, T2, T3, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-4.html">ICallGateProvider</a><T1, T2, T3, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__5_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%605(System.String)%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/Plugin/DalamudPluginInterface.cs/#L198">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__5_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``5(System.String)">GetIpcProvider<T1, T2, T3, T4, TRet>(String)</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 ICallGateProvider<T1, T2, T3, T4, TRet> GetIpcProvider<T1, T2, T3, T4, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-5.html">ICallGateProvider</a><T1, T2, T3, T4, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__6_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%606(System.String)%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/Plugin/DalamudPluginInterface.cs/#L202">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__6_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``6(System.String)">GetIpcProvider<T1, T2, T3, T4, T5, TRet>(String)</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 ICallGateProvider<T1, T2, T3, T4, T5, TRet> GetIpcProvider<T1, T2, T3, T4, T5, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-6.html">ICallGateProvider</a><T1, T2, T3, T4, T5, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__7_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%607(System.String)%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/Plugin/DalamudPluginInterface.cs/#L206">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__7_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``7(System.String)">GetIpcProvider<T1, T2, T3, T4, T5, T6, TRet>(String)</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 ICallGateProvider<T1, T2, T3, T4, T5, T6, TRet> GetIpcProvider<T1, T2, T3, T4, T5, T6, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-7.html">ICallGateProvider</a><T1, T2, T3, T4, T5, T6, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__8_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%608(System.String)%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/Plugin/DalamudPluginInterface.cs/#L210">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__8_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``8(System.String)">GetIpcProvider<T1, T2, T3, T4, T5, T6, T7, TRet>(String)</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 ICallGateProvider<T1, T2, T3, T4, T5, T6, T7, TRet> GetIpcProvider<T1, T2, T3, T4, T5, T6, T7, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-8.html">ICallGateProvider</a><T1, T2, T3, T4, T5, T6, T7, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T7</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcProvider__9_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider%60%609(System.String)%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/Plugin/DalamudPluginInterface.cs/#L214">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcProvider__9_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcProvider``9(System.String)">GetIpcProvider<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(String)</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 ICallGateProvider<T1, T2, T3, T4, T5, T6, T7, T8, TRet> GetIpcProvider<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateProvider-9.html">ICallGateProvider</a><T1, T2, T3, T4, T5, T6, T7, T8, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T7</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T8</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__1_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%601(System.String)%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/Plugin/DalamudPluginInterface.cs/#L223">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__1_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``1(System.String)">GetIpcSubscriber<TRet>(String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets an IPC subscriber.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ICallGateSubscriber<TRet> GetIpcSubscriber<TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>The name of the IPC registration.</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.Plugin.Ipc.ICallGateSubscriber-1.html">ICallGateSubscriber</a><TRet></td>
|
|
<td><p>An IPC subscriber.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TRet</span></td>
|
|
<td><p>The return type for funcs. Use object if this is unused.</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__2_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%602(System.String)%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/Plugin/DalamudPluginInterface.cs/#L227">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__2_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``2(System.String)">GetIpcSubscriber<T1, TRet>(String)</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 ICallGateSubscriber<T1, TRet> GetIpcSubscriber<T1, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-2.html">ICallGateSubscriber</a><T1, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__3_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%603(System.String)%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/Plugin/DalamudPluginInterface.cs/#L231">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__3_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``3(System.String)">GetIpcSubscriber<T1, T2, TRet>(String)</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 ICallGateSubscriber<T1, T2, TRet> GetIpcSubscriber<T1, T2, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-3.html">ICallGateSubscriber</a><T1, T2, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__4_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%604(System.String)%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/Plugin/DalamudPluginInterface.cs/#L235">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__4_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``4(System.String)">GetIpcSubscriber<T1, T2, T3, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, TRet> GetIpcSubscriber<T1, T2, T3, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-4.html">ICallGateSubscriber</a><T1, T2, T3, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__5_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%605(System.String)%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/Plugin/DalamudPluginInterface.cs/#L239">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__5_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``5(System.String)">GetIpcSubscriber<T1, T2, T3, T4, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, T4, TRet> GetIpcSubscriber<T1, T2, T3, T4, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-5.html">ICallGateSubscriber</a><T1, T2, T3, T4, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__6_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%606(System.String)%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/Plugin/DalamudPluginInterface.cs/#L243">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__6_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``6(System.String)">GetIpcSubscriber<T1, T2, T3, T4, T5, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, T4, T5, TRet> GetIpcSubscriber<T1, T2, T3, T4, T5, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-6.html">ICallGateSubscriber</a><T1, T2, T3, T4, T5, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__7_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%607(System.String)%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/Plugin/DalamudPluginInterface.cs/#L247">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__7_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``7(System.String)">GetIpcSubscriber<T1, T2, T3, T4, T5, T6, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, T4, T5, T6, TRet> GetIpcSubscriber<T1, T2, T3, T4, T5, T6, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-7.html">ICallGateSubscriber</a><T1, T2, T3, T4, T5, T6, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__8_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%608(System.String)%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/Plugin/DalamudPluginInterface.cs/#L251">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__8_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``8(System.String)">GetIpcSubscriber<T1, T2, T3, T4, T5, T6, T7, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, T4, T5, T6, T7, TRet> GetIpcSubscriber<T1, T2, T3, T4, T5, T6, T7, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-8.html">ICallGateSubscriber</a><T1, T2, T3, T4, T5, T6, T7, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T7</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetIpcSubscriber__9_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber%60%609(System.String)%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/Plugin/DalamudPluginInterface.cs/#L255">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetIpcSubscriber__9_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetIpcSubscriber``9(System.String)">GetIpcSubscriber<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(String)</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 ICallGateSubscriber<T1, T2, T3, T4, T5, T6, T7, T8, TRet> GetIpcSubscriber<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(string name)</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.String</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td></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.Plugin.Ipc.ICallGateSubscriber-9.html">ICallGateSubscriber</a><T1, T2, T3, T4, T5, T6, T7, T8, TRet></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T2</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T3</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T4</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T5</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T6</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T7</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">T8</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TRet</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_Plugin_DalamudPluginInterface_GetPluginConfig.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig%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/Plugin/DalamudPluginInterface.cs/#L278">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig">GetPluginConfig()</h4>
|
|
<div class="markdown level1 summary"><p>Get a previously saved plugin configuration or null if none was saved before.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IPluginConfiguration GetPluginConfig()</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><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
|
|
<td><p>A previously saved config or null if none was saved before.</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_Plugin_DalamudPluginInterface_GetPluginConfigDirectory.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetPluginConfigDirectory%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/Plugin/DalamudPluginInterface.cs/#L305">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfigDirectory_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfigDirectory*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfigDirectory" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfigDirectory">GetPluginConfigDirectory()</h4>
|
|
<div class="markdown level1 summary"><p>Get the config directory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string GetPluginConfigDirectory()</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.String</span></td>
|
|
<td><p>directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName.</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_Plugin_DalamudPluginInterface_GetPluginLocDirectory.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory%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/Plugin/DalamudPluginInterface.cs/#L311">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_GetPluginLocDirectory_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetPluginLocDirectory" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory">GetPluginLocDirectory()</h4>
|
|
<div class="markdown level1 summary"><p>Get the loc directory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string GetPluginLocDirectory()</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.String</span></td>
|
|
<td><p>directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName/loc.</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_Plugin_DalamudPluginInterface_Inject_System_Object_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Inject(System.Object%2CSystem.Object%5B%5D)%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/Plugin/DalamudPluginInterface.cs/#L371">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Inject_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Inject*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Inject_System_Object_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.Inject(System.Object,System.Object[])">Inject(Object, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Inject services into properties on the provided object instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool Inject(object instance, params object[] scopedObjects)</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.Object</span></td>
|
|
<td><span class="parametername">instance</span></td>
|
|
<td><p>The instance to inject services into.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">scopedObjects</span></td>
|
|
<td><p>Objects to inject additionally.</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.Boolean</span></td>
|
|
<td><p>Whether or not the injection succeeded.</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_Plugin_DalamudPluginInterface_RemoveChatLinkHandler.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler%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/Plugin/DalamudPluginInterface.cs/#L340">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler">RemoveChatLinkHandler()</h4>
|
|
<div class="markdown level1 summary"><p>Removes all chat link handlers registered by the plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void RemoveChatLinkHandler()</code></pre>
|
|
</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_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_System_UInt32_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler(System.UInt32)%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/Plugin/DalamudPluginInterface.cs/#L332">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_System_UInt32_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler(System.UInt32)">RemoveChatLinkHandler(UInt32)</h4>
|
|
<div class="markdown level1 summary"><p>Remove a chat link handler.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void RemoveChatLinkHandler(uint commandId)</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.UInt32</span></td>
|
|
<td><span class="parametername">commandId</span></td>
|
|
<td><p>The ID of the command.</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_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig(Dalamud.Configuration.IPluginConfiguration)%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/Plugin/DalamudPluginInterface.cs/#L266">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig(Dalamud.Configuration.IPluginConfiguration)">SavePluginConfig(IPluginConfiguration)</h4>
|
|
<div class="markdown level1 summary"><p>Save a plugin configuration(inheriting IPluginConfiguration).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SavePluginConfig(IPluginConfiguration currentConfig)</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><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
|
|
<td><span class="parametername">currentConfig</span></td>
|
|
<td><p>The current configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="events">Events
|
|
</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_Plugin_DalamudPluginInterface_LanguageChanged.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LanguageChanged%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/Plugin/DalamudPluginInterface.cs/#L87">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LanguageChanged" data-uid="Dalamud.Plugin.DalamudPluginInterface.LanguageChanged">LanguageChanged</h4>
|
|
<div class="markdown level1 summary"><p>Event that gets fired when loc is changed</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event DalamudPluginInterface.LanguageChangedDelegate LanguageChanged</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</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.Plugin.DalamudPluginInterface.LanguageChangedDelegate.html">DalamudPluginInterface.LanguageChangedDelegate</a></td>
|
|
<td></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_Plugin_DalamudPluginInterface_System_IDisposable_Dispose.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.System%23IDisposable%23Dispose%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/Plugin/DalamudPluginInterface.cs/#L387">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_System_IDisposable_Dispose_" data-uid="Dalamud.Plugin.DalamudPluginInterface.System#IDisposable#Dispose*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_System_IDisposable_Dispose" data-uid="Dalamud.Plugin.DalamudPluginInterface.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Unregister your plugin and dispose all references.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void IDisposable.Dispose()</code></pre>
|
|
</div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.IDisposable</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_Plugin_DalamudPluginInterface.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface%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/Plugin/DalamudPluginInterface.cs/#L29" 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>
|