mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
171 lines
7 KiB
HTML
171 lines
7 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>Enum SignatureUseFlags
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Enum SignatureUseFlags
|
|
">
|
|
<meta name="generator" content="docfx 2.59.1.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Utility.Signatures.SignatureUseFlags">
|
|
|
|
|
|
<h1 id="Dalamud_Utility_Signatures_SignatureUseFlags" data-uid="Dalamud.Utility.Signatures.SignatureUseFlags" class="text-break">Enum SignatureUseFlags
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Use flags for a signature attribute. This tells SignatureHelper how to use the
|
|
result of the signature.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Utility.Signatures.html">Dalamud.Utility.Signatures</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Utility_Signatures_SignatureUseFlags_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public enum SignatureUseFlags</code></pre>
|
|
</div>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<thead>
|
|
<tbody>
|
|
<tr>
|
|
<td id="Dalamud_Utility_Signatures_SignatureUseFlags_Auto">Auto</td>
|
|
<td><p>SignatureHelper will use simple heuristics to determine the best signature
|
|
use for the field/property.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Dalamud_Utility_Signatures_SignatureUseFlags_Hook">Hook</td>
|
|
<td><p>The signature should be used as a hook. This is correct for
|
|
<a class="xref" href="Dalamud.Hooking.Hook-1.html">Hook<T></a> fields/properties.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Dalamud_Utility_Signatures_SignatureUseFlags_Offset">Offset</td>
|
|
<td><p>The signature should be used to determine an offset. This is the default
|
|
for all primitive types. SignatureHelper will read from the memory at this
|
|
signature and store the result in the field/property. An offset from the
|
|
signature can be specified in the <a class="xref" href="Dalamud.Utility.Signatures.SignatureAttribute.html">SignatureAttribute</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Dalamud_Utility_Signatures_SignatureUseFlags_Pointer">Pointer</td>
|
|
<td><p>The signature should be used as a plain pointer. This is correct for
|
|
static addresses, functions, or anything else that's an
|
|
<span class="xref">System.IntPtr</span> at heart.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</thead></thead></table>
|
|
<h3 id="extensionmethods">Extension Methods</h3>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Utility.EnumExtensions.html#Dalamud_Utility_EnumExtensions_GetAttribute__1_System_Enum_">EnumExtensions.GetAttribute<TAttribute>()</a>
|
|
</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_Utility_Signatures_SignatureUseFlags.md&value=---%0Auid%3A%20Dalamud.Utility.Signatures.SignatureUseFlags%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/Utility/Signatures/SignatureUseFlags.cs/#L11" 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>
|