UniTask/api/Cysharp.Threading.Tasks.Tri...

407 lines
20 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>AsyncTriggerBase&lt;T&gt; Class
| UniTask </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="AsyncTriggerBase&lt;T&gt; Class
| UniTask ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/cysharp.css">
<meta property="docfx:navrel" content="../toc.html">
<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-default 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>
<div class="navbar-brand">
<a href="../">
<img id="logo" src="../img/Icon.png" alt="">
<span>UniTask</span>
</a>
</div>
</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="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1">
<h1 id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1" class="text-break">AsyncTriggerBase&lt;T&gt; Class
</h1>
<h6><strong>Namespace</strong>: <a class="xref" href="Cysharp.Threading.Tasks.Triggers.html">Cysharp.Threading.Tasks.Triggers</a></h6>
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class AsyncTriggerBase&lt;T&gt; : MonoBehaviour, IUniTaskAsyncEnumerable&lt;T&gt;</code></pre>
</div>
<div class="inheritance">
<h5>Inheritance</h5>
<span><span class="xref">System.Object</span></span>
<span class="xref">AsyncTriggerBase&lt;T&gt;</span>
</div>
<div class="inheritance">
<h5>Derived</h5>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncAnimatorIKTrigger.html">AsyncAnimatorIKTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncAnimatorMoveTrigger.html">AsyncAnimatorMoveTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncApplicationFocusTrigger.html">AsyncApplicationFocusTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncApplicationPauseTrigger.html">AsyncApplicationPauseTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncApplicationQuitTrigger.html">AsyncApplicationQuitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncAudioFilterReadTrigger.html">AsyncAudioFilterReadTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncAwakeTrigger.html">AsyncAwakeTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncBecameInvisibleTrigger.html">AsyncBecameInvisibleTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncBecameVisibleTrigger.html">AsyncBecameVisibleTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncBeforeTransformParentChangedTrigger.html">AsyncBeforeTransformParentChangedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncBeginDragTrigger.html">AsyncBeginDragTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCancelTrigger.html">AsyncCancelTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionEnter2DTrigger.html">AsyncCollisionEnter2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionEnterTrigger.html">AsyncCollisionEnterTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionExit2DTrigger.html">AsyncCollisionExit2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionExitTrigger.html">AsyncCollisionExitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionStay2DTrigger.html">AsyncCollisionStay2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncCollisionStayTrigger.html">AsyncCollisionStayTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncControllerColliderHitTrigger.html">AsyncControllerColliderHitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDeselectTrigger.html">AsyncDeselectTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDisableTrigger.html">AsyncDisableTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDragTrigger.html">AsyncDragTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDrawGizmosSelectedTrigger.html">AsyncDrawGizmosSelectedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDrawGizmosTrigger.html">AsyncDrawGizmosTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncDropTrigger.html">AsyncDropTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncEnableTrigger.html">AsyncEnableTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncEndDragTrigger.html">AsyncEndDragTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncFixedUpdateTrigger.html">AsyncFixedUpdateTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncGUITrigger.html">AsyncGUITrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncInitializePotentialDragTrigger.html">AsyncInitializePotentialDragTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncJointBreak2DTrigger.html">AsyncJointBreak2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncJointBreakTrigger.html">AsyncJointBreakTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncLateUpdateTrigger.html">AsyncLateUpdateTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseDownTrigger.html">AsyncMouseDownTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseDragTrigger.html">AsyncMouseDragTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseEnterTrigger.html">AsyncMouseEnterTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseExitTrigger.html">AsyncMouseExitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseOverTrigger.html">AsyncMouseOverTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseUpAsButtonTrigger.html">AsyncMouseUpAsButtonTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMouseUpTrigger.html">AsyncMouseUpTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncMoveTrigger.html">AsyncMoveTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncOnCanvasGroupChangedTrigger.html">AsyncOnCanvasGroupChangedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncParticleCollisionTrigger.html">AsyncParticleCollisionTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncParticleSystemStoppedTrigger.html">AsyncParticleSystemStoppedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncParticleTriggerTrigger.html">AsyncParticleTriggerTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPointerClickTrigger.html">AsyncPointerClickTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPointerDownTrigger.html">AsyncPointerDownTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPointerEnterTrigger.html">AsyncPointerEnterTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPointerExitTrigger.html">AsyncPointerExitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPointerUpTrigger.html">AsyncPointerUpTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPostRenderTrigger.html">AsyncPostRenderTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPreCullTrigger.html">AsyncPreCullTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncPreRenderTrigger.html">AsyncPreRenderTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncRectTransformDimensionsChangeTrigger.html">AsyncRectTransformDimensionsChangeTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncRectTransformRemovedTrigger.html">AsyncRectTransformRemovedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncRenderImageTrigger.html">AsyncRenderImageTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncRenderObjectTrigger.html">AsyncRenderObjectTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncResetTrigger.html">AsyncResetTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncScrollTrigger.html">AsyncScrollTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncSelectTrigger.html">AsyncSelectTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncServerInitializedTrigger.html">AsyncServerInitializedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncStartTrigger.html">AsyncStartTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncSubmitTrigger.html">AsyncSubmitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTransformChildrenChangedTrigger.html">AsyncTransformChildrenChangedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTransformParentChangedTrigger.html">AsyncTransformParentChangedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerEnter2DTrigger.html">AsyncTriggerEnter2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerEnterTrigger.html">AsyncTriggerEnterTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerExit2DTrigger.html">AsyncTriggerExit2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerExitTrigger.html">AsyncTriggerExitTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerStay2DTrigger.html">AsyncTriggerStay2DTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerStayTrigger.html">AsyncTriggerStayTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncUpdateSelectedTrigger.html">AsyncUpdateSelectedTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncUpdateTrigger.html">AsyncUpdateTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncValidateTrigger.html">AsyncValidateTrigger</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncWillRenderObjectTrigger.html">AsyncWillRenderObjectTrigger</a></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Cysharp.Threading.Tasks.IUniTaskAsyncEnumerable-1.html">IUniTaskAsyncEnumerable</a>&lt;T&gt;</div>
</div>
<section>
<h4 class="typeParameters">Type Parameters</h4>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
<h3 id="members">Members</h3>
<h4>Fields
</h4>
<table class="table table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase-1.html#Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_calledAwake">calledAwake</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase-1.html#Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_calledDestroy">calledDestroy</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<h4>Methods
</h4>
<table class="table table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase-1.html#Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_GetAsyncEnumerator_System_Threading_CancellationToken_">GetAsyncEnumerator(CancellationToken)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase-1.html#Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_RaiseEvent__0_">RaiseEvent(T)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<section>
<h4 id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_calledAwake" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.calledAwake">calledAwake</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool calledAwake</code></pre>
</div>
<section>
<h5 class="fieldValue">Field Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">System.Boolean</span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<h4 id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_calledDestroy" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.calledDestroy">calledDestroy</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool calledDestroy</code></pre>
</div>
<section>
<h5 class="fieldValue">Field Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">System.Boolean</span></dt>
<dd></dd>
</dl>
</section>
</section>
<h3 id="methods">Methods
</h3>
<section>
<a id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_GetAsyncEnumerator_" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.GetAsyncEnumerator*"></a>
<h4 id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_GetAsyncEnumerator_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.GetAsyncEnumerator(System.Threading.CancellationToken)">GetAsyncEnumerator(CancellationToken)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IUniTaskAsyncEnumerator&lt;T&gt; GetAsyncEnumerator(CancellationToken cancellationToken = default(CancellationToken))</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">System.Threading.CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.IUniTaskAsyncEnumerator-1.html">IUniTaskAsyncEnumerator</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_RaiseEvent_" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.RaiseEvent*"></a>
<h4 id="Cysharp_Threading_Tasks_Triggers_AsyncTriggerBase_1_RaiseEvent__0_" data-uid="Cysharp.Threading.Tasks.Triggers.AsyncTriggerBase`1.RaiseEvent(`0)">RaiseEvent(T)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void RaiseEvent(T value)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>value</code></span> <span class="xref">T</span></dt>
<dd></dd>
</dl>
</section>
</section>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.IUniTaskAsyncEnumerable-1.html">IUniTaskAsyncEnumerable&lt;T&gt;</a>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<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="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © <a href="https://cysharp.co.jp/">Cysharp</a>, Inc. | <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/docfx.override.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>