ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Plugin.DalamudPluginInterface.html
goat 94571bb41b docs: regenerate
2020-05-14 22:49:06 +02:00

711 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class DalamudPluginInterface
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DalamudPluginInterface
">
<meta name="generator" content="docfx 2.48.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.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="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface__ctor_Dalamud_Dalamud_System_String_Dalamud_Configuration_PluginConfigurations_.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.%23ctor(Dalamud.Dalamud%2CSystem.String%2CDalamud.Configuration.PluginConfigurations)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L62">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface__ctor_" data-uid="Dalamud.Plugin.DalamudPluginInterface.#ctor*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface__ctor_Dalamud_Dalamud_System_String_Dalamud_Configuration_PluginConfigurations_" data-uid="Dalamud.Plugin.DalamudPluginInterface.#ctor(Dalamud.Dalamud,System.String,Dalamud.Configuration.PluginConfigurations)">DalamudPluginInterface(Dalamud, String, PluginConfigurations)</h4>
<div class="markdown level1 summary"><p>Set up the interface and populate all fields needed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DalamudPluginInterface(Dalamud dalamud, string pluginName, PluginConfigurations configs)</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">Dalamud.Dalamud</span></td>
<td><span class="parametername">dalamud</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Configuration.PluginConfigurations.html">PluginConfigurations</a></td>
<td><span class="parametername">configs</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_ClientState.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L32">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_ClientState" data-uid="Dalamud.Plugin.DalamudPluginInterface.ClientState">ClientState</h4>
<div class="markdown level1 summary"><p>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 readonly ClientState ClientState</code></pre>
</div>
<h5 class="fieldValue">Field 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_CommandManager.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L27">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_CommandManager" data-uid="Dalamud.Plugin.DalamudPluginInterface.CommandManager">CommandManager</h4>
<div class="markdown level1 summary"><p>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 readonly CommandManager CommandManager</code></pre>
</div>
<h5 class="fieldValue">Field 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Data.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L52">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Data" data-uid="Dalamud.Plugin.DalamudPluginInterface.Data">Data</h4>
<div class="markdown level1 summary"><p>A <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 readonly DataManager Data</code></pre>
</div>
<h5 class="fieldValue">Field 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Framework.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L37">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Framework" data-uid="Dalamud.Plugin.DalamudPluginInterface.Framework">Framework</h4>
<div class="markdown level1 summary"><p>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 readonly Framework Framework</code></pre>
</div>
<h5 class="fieldValue">Field 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L47">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner" data-uid="Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner">TargetModuleScanner</h4>
<div class="markdown level1 summary"><p>A <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 readonly SigScanner TargetModuleScanner</code></pre>
</div>
<h5 class="fieldValue">Field 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_UiBuilder.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L42">View Source</a>
</span>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UiBuilder" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiBuilder">UiBuilder</h4>
<div class="markdown level1 summary"><p>A <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 readonly UiBuilder UiBuilder</code></pre>
</div>
<h5 class="fieldValue">Field 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>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Dispose.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L78">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L97">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L165">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L187">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L175">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L86">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_Dynamic_ExpandoObject_.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L149">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">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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Subscribe_System_String_System_Action_System_Dynamic_ExpandoObject__.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L126">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&lt;ExpandoObject&gt;)</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">public void Subscribe(string pluginName, Action&lt;ExpandoObject&gt; 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>&lt;<span class="xref">System.Dynamic.ExpandoObject</span>&gt;</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_System_String_.md&amp;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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L137">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">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>
<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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface.md&amp;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/goaaats/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">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink