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.Game.Gui.FlyText.FlyTextGui.html
goat cc362d5fd7
docs: regenerate
2021-12-06 19:14:46 +01:00

290 lines
14 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 FlyTextGui
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FlyTextGui
">
<meta name="generator" content="docfx 2.58.9.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui">
<h1 id="Dalamud_Game_Gui_FlyText_FlyTextGui" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui" class="text-break">Class FlyTextGui
</h1>
<div class="markdown level0 summary"><p>This class facilitates interacting with and creating native in-game &quot;fly text&quot;.</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">FlyTextGui</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.Gui.FlyText.html">Dalamud.Game.Gui.FlyText</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_Gui_FlyText_FlyTextGui_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class FlyTextGui : IDisposable</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_FlyText_FlyTextGui_AddFlyText_Dalamud_Game_Gui_FlyText_FlyTextKind_System_UInt32_System_UInt32_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Text_SeStringHandling_SeString_System_UInt32_System_UInt32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.FlyText.FlyTextGui.AddFlyText(Dalamud.Game.Gui.FlyText.FlyTextKind%2CSystem.UInt32%2CSystem.UInt32%2CSystem.UInt32%2CDalamud.Game.Text.SeStringHandling.SeString%2CDalamud.Game.Text.SeStringHandling.SeString%2CSystem.UInt32%2CSystem.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/Game/Gui/FlyText/FlyTextGui.cs/#L124">View Source</a>
</span>
<a id="Dalamud_Game_Gui_FlyText_FlyTextGui_AddFlyText_" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.AddFlyText*"></a>
<h4 id="Dalamud_Game_Gui_FlyText_FlyTextGui_AddFlyText_Dalamud_Game_Gui_FlyText_FlyTextKind_System_UInt32_System_UInt32_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Text_SeStringHandling_SeString_System_UInt32_System_UInt32_" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.AddFlyText(Dalamud.Game.Gui.FlyText.FlyTextKind,System.UInt32,System.UInt32,System.UInt32,Dalamud.Game.Text.SeStringHandling.SeString,Dalamud.Game.Text.SeStringHandling.SeString,System.UInt32,System.UInt32)">AddFlyText(FlyTextKind, UInt32, UInt32, UInt32, SeString, SeString, UInt32, UInt32)</h4>
<div class="markdown level1 summary"><p>Displays a fly text in-game on the local player.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AddFlyText(FlyTextKind kind, uint actorIndex, uint val1, uint val2, SeString text1, SeString text2, uint color, uint icon)</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.Game.Gui.FlyText.FlyTextKind.html">FlyTextKind</a></td>
<td><span class="parametername">kind</span></td>
<td><p>The FlyTextKind. See <a class="xref" href="Dalamud.Game.Gui.FlyText.FlyTextKind.html">FlyTextKind</a>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">actorIndex</span></td>
<td><p>The index of the actor to place flytext on. Indexing unknown. 1 places flytext on local player.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">val1</span></td>
<td><p>Value1 passed to the native flytext function.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">val2</span></td>
<td><p>Value2 passed to the native flytext function. Seems unused.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><span class="parametername">text1</span></td>
<td><p>Text1 passed to the native flytext function.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><span class="parametername">text2</span></td>
<td><p>Text2 passed to the native flytext function.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">color</span></td>
<td><p>Color passed to the native flytext function. Changes flytext color.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">icon</span></td>
<td><p>Icon ID passed to the native flytext function. Only displays with select FlyTextKind.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_FlyText_FlyTextGui_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.FlyText.FlyTextGui.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/Game/Gui/FlyText/FlyTextGui.cs/#L108">View Source</a>
</span>
<a id="Dalamud_Game_Gui_FlyText_FlyTextGui_Dispose_" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.Dispose*"></a>
<h4 id="Dalamud_Game_Gui_FlyText_FlyTextGui_Dispose" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Disposes of managed and unmanaged resources.</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>
<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_Game_Gui_FlyText_FlyTextGui_FlyTextCreated.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.FlyText.FlyTextGui.FlyTextCreated%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/FlyText/FlyTextGui.cs/#L99">View Source</a>
</span>
<h4 id="Dalamud_Game_Gui_FlyText_FlyTextGui_FlyTextCreated" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.FlyTextCreated">FlyTextCreated</h4>
<div class="markdown level1 summary"><p>The FlyText event that can be subscribed to.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event FlyTextGui.OnFlyTextCreatedDelegate FlyTextCreated</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.Game.Gui.FlyText.FlyTextGui.OnFlyTextCreatedDelegate.html">FlyTextGui.OnFlyTextCreatedDelegate</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_Game_Gui_FlyText_FlyTextGui.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.FlyText.FlyTextGui%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/FlyText/FlyTextGui.cs/#L17" 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>
Reference in a new issue View git blame Copy permalink