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.OnFlyTextCreatedDelegate.html
goat 83586fd46b
docs: regenerate
2023-01-26 23:57:38 +01:00

200 lines
8.3 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>Delegate FlyTextGui.OnFlyTextCreatedDelegate
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Delegate FlyTextGui.OnFlyTextCreatedDelegate
">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.OnFlyTextCreatedDelegate">
<h1 id="Dalamud_Game_Gui_FlyText_FlyTextGui_OnFlyTextCreatedDelegate" data-uid="Dalamud.Game.Gui.FlyText.FlyTextGui.OnFlyTextCreatedDelegate" class="text-break">Delegate FlyTextGui.OnFlyTextCreatedDelegate
</h1>
<div class="markdown level0 summary"><p>The delegate defining the type for the FlyText event.</p>
</div>
<div class="markdown level0 conceptual"></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_OnFlyTextCreatedDelegate_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public delegate void OnFlyTextCreatedDelegate(ref FlyTextKind kind, ref int val1, ref int val2, ref SeString text1, ref SeString text2, ref uint color, ref uint icon, ref uint damageTypeIcon, ref float yOffset, ref bool handled);</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.Int32</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.Int32</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>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">damageTypeIcon</span></td>
<td><p>Damage Type Icon ID passed to the native flytext function. Displayed next to damage values to denote damage type.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">yOffset</span></td>
<td><p>The vertical offset to place the flytext at. 0 is default. Negative values result
in text appearing higher on the screen. This does not change where the element begins to fade.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">handled</span></td>
<td><p>Whether this flytext has been handled. If a subscriber sets this to true, the FlyText will not appear.</p>
</td>
</tr>
</tbody>
</table>
</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_OnFlyTextCreatedDelegate.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.FlyText.FlyTextGui.OnFlyTextCreatedDelegate%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/#L56" 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