mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
1235 lines
65 KiB
HTML
1235 lines
65 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.56.6.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.ToString()</span>
|
|
</div>
|
|
<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.ReferenceEquals(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>
|
|
<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 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_ClientState.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.ClientState%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/#L96">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_ClientState_" data-uid="Dalamud.Plugin.DalamudPluginInterface.ClientState*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_ClientState" data-uid="Dalamud.Plugin.DalamudPluginInterface.ClientState">ClientState</h4>
|
|
<div class="markdown level1 summary"><p>Gets the ClientState object that allows you to access current client memory information like actors, territories, etc.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ClientState ClientState { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.ClientState.ClientState.html">ClientState</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_CommandManager.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.CommandManager%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/#L91">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_CommandManager_" data-uid="Dalamud.Plugin.DalamudPluginInterface.CommandManager*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_CommandManager" data-uid="Dalamud.Plugin.DalamudPluginInterface.CommandManager">CommandManager</h4>
|
|
<div class="markdown level1 summary"><p>Gets the CommandManager object that allows you to add and remove custom chat commands.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CommandManager CommandManager { 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.Command.CommandManager.html">CommandManager</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_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/#L81">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/#L86">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/#L76">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_Data.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Data%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/#L116">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Data_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Data*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Data" data-uid="Dalamud.Plugin.DalamudPluginInterface.Data">Data</h4>
|
|
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Dalamud.Data.DataManager.html">DataManager</a> instance which allows you to access game data needed by the main dalamud features.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DataManager Data { 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.Data.DataManager.html">DataManager</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_Framework.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Framework%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/#L101">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Framework_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Framework*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Framework" data-uid="Dalamud.Plugin.DalamudPluginInterface.Framework">Framework</h4>
|
|
<div class="markdown level1 summary"><p>Gets the Framework object that allows you to interact with the client.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Framework Framework { 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.Internal.Framework.html">Framework</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/#L129">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_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/#L71">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/#L140">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_SeStringManager.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SeStringManager%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/#L121">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_SeStringManager_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SeStringManager*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SeStringManager" data-uid="Dalamud.Plugin.DalamudPluginInterface.SeStringManager">SeStringManager</h4>
|
|
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_SeStringManager">SeStringManager</a> instance which allows creating and parsing SeString payloads.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SeStringManager SeStringManager { 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.SeStringHandling.SeStringManager.html">SeStringManager</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_TargetModuleScanner.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner%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/#L111">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner_" data-uid="Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner" data-uid="Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner">TargetModuleScanner</h4>
|
|
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Dalamud.Game.SigScanner.html">SigScanner</a> instance targeting the main module of the FFXIV process.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SigScanner TargetModuleScanner { 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.SigScanner.html">SigScanner</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/#L106">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/#L135">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/#L206">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_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/#L359">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>Unregister your plugin and dispose all references. You have to call this when your IDalamudPlugin is disposed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">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_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/#L163">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/#L190">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/#L196">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_Log_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Log(System.String%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/#L325">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Log_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log(System.String,System.Object[])">Log(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete]
|
|
public void Log(string messageTemplate, params object[] values)</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">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</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_LogError_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception%2CSystem.String%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/#L348">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception,System.String,System.Object[])">LogError(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete]
|
|
public void LogError(Exception exception, string messageTemplate, params object[] values)</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.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</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_LogError_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.String%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/#L336">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.String,System.Object[])">LogError(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete]
|
|
public void LogError(string messageTemplate, params object[] values)</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">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</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/#L223">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/#L215">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/#L151">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>
|
|
<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_SendMessage_System_Dynamic_ExpandoObject_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.Dynamic.ExpandoObject)%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/#L288">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_Dynamic_ExpandoObject_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.Dynamic.ExpandoObject)">SendMessage(ExpandoObject)</h4>
|
|
<div class="markdown level1 summary"><p>Send a message to all subscribed plugins.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public void SendMessage(ExpandoObject message)</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.Dynamic.ExpandoObject</span></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to send.</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_SendMessage_System_String_System_Dynamic_ExpandoObject_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.String%2CSystem.Dynamic.ExpandoObject)%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/#L304">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_String_System_Dynamic_ExpandoObject_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.String,System.Dynamic.ExpandoObject)">SendMessage(String, ExpandoObject)</h4>
|
|
<div class="markdown level1 summary"><p>Send a message to a specific plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public bool SendMessage(string pluginName, ExpandoObject message)</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">pluginName</span></td>
|
|
<td><p>The InternalName of the plugin to send the message to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Dynamic.ExpandoObject</span></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to send.</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>True if the corresponding plugin was present and received the message.</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_Subscribe_System_String_System_Action_System_Dynamic_ExpandoObject__.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Subscribe(System.String%2CSystem.Action%7BSystem.Dynamic.ExpandoObject%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/#L249">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Subscribe_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Subscribe*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Subscribe_System_String_System_Action_System_Dynamic_ExpandoObject__" data-uid="Dalamud.Plugin.DalamudPluginInterface.Subscribe(System.String,System.Action{System.Dynamic.ExpandoObject})">Subscribe(String, Action<ExpandoObject>)</h4>
|
|
<div class="markdown level1 summary"><p>Subscribe to an IPC message by a plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public void Subscribe(string pluginName, Action<ExpandoObject> action)</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">pluginName</span></td>
|
|
<td><p>The InternalName of the plugin to subscribe to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span><<span class="xref">System.Dynamic.ExpandoObject</span>></td>
|
|
<td><span class="parametername">action</span></td>
|
|
<td><p>The action to take when a message was received.</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_SubscribeAny_System_Action_System_String_System_Dynamic_ExpandoObject__.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SubscribeAny(System.Action%7BSystem.String%2CSystem.Dynamic.ExpandoObject%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/#L235">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_SubscribeAny_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SubscribeAny*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SubscribeAny_System_Action_System_String_System_Dynamic_ExpandoObject__" data-uid="Dalamud.Plugin.DalamudPluginInterface.SubscribeAny(System.Action{System.String,System.Dynamic.ExpandoObject})">SubscribeAny(Action<String, ExpandoObject>)</h4>
|
|
<div class="markdown level1 summary"><p>Subscribe to an IPC message by any plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public void SubscribeAny(Action<string, ExpandoObject> action)</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.Action</span><<span class="xref">System.String</span>, <span class="xref">System.Dynamic.ExpandoObject</span>></td>
|
|
<td><span class="parametername">action</span></td>
|
|
<td><p>The action to take when a message was received.</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_Unsubscribe_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Unsubscribe(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/#L274">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Unsubscribe*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Unsubscribe(System.String)">Unsubscribe(String)</h4>
|
|
<div class="markdown level1 summary"><p>Unsubscribe from messages from a plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public void Unsubscribe(string pluginName)</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">pluginName</span></td>
|
|
<td><p>The InternalName of the plugin to unsubscribe from.</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_UnsubscribeAny.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny%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/#L261">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Plugin_DalamudPluginInterface_UnsubscribeAny_" data-uid="Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny*"></a>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UnsubscribeAny" data-uid="Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny">UnsubscribeAny()</h4>
|
|
<div class="markdown level1 summary"><p>Unsubscribe from messages from any plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.")]
|
|
public void UnsubscribeAny()</code></pre>
|
|
</div>
|
|
<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_OnLanguageChanged.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.OnLanguageChanged%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/#L66">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Plugin_DalamudPluginInterface_OnLanguageChanged" data-uid="Dalamud.Plugin.DalamudPluginInterface.OnLanguageChanged">OnLanguageChanged</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 OnLanguageChanged</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="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/#L23" 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>
|