Files
UniTask/api/Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html
2025-09-10 09:25:16 +00:00

472 lines
21 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>AsyncInstantiateOperationExtensions Class
| UniTask </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="AsyncInstantiateOperationExtensions Class
| UniTask ">
<meta name="generator" content="docfx ">
<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.AsyncInstantiateOperationExtensions">
<h1 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions" class="text-break">AsyncInstantiateOperationExtensions Class
</h1>
<h6><strong>Namespace</strong>: <a class="xref" href="Cysharp.html">Cysharp</a>.<a class="xref" href="Cysharp.Threading.html">Threading</a>.<a class="xref" href="Cysharp.Threading.Tasks.html">Tasks</a></h6>
<h6><strong>Assembly</strong>: UniTask.dll</h6>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static class AsyncInstantiateOperationExtensions</code></pre>
</div>
<div class="inheritance">
<h5>Inheritance</h5>
<span><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></span>
<span class="xref">AsyncInstantiateOperationExtensions</span>
</div>
<h3 id="members">Members</h3>
<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.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask_UnityEngine_AsyncInstantiateOperation_System_IProgress_System_Single__Cysharp_Threading_Tasks_PlayerLoopTiming_System_Threading_CancellationToken_System_Boolean_">ToUniTask(AsyncInstantiateOperation, IProgress&lt;float&gt;, PlayerLoopTiming, CancellationToken, bool)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask__1_UnityEngine_AsyncInstantiateOperation___0__System_IProgress_System_Single__Cysharp_Threading_Tasks_PlayerLoopTiming_System_Threading_CancellationToken_System_Boolean_">ToUniTask&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, IProgress&lt;float&gt;, PlayerLoopTiming, CancellationToken, bool)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation_System_Threading_CancellationToken_">WithCancellation&lt;T&gt;(AsyncInstantiateOperation, CancellationToken)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation_System_Threading_CancellationToken_System_Boolean_">WithCancellation&lt;T&gt;(AsyncInstantiateOperation, CancellationToken, bool)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation___0__System_Threading_CancellationToken_">WithCancellation&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, CancellationToken)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.html#Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation___0__System_Threading_CancellationToken_System_Boolean_">WithCancellation&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, CancellationToken, bool)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.ToUniTask*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask_UnityEngine_AsyncInstantiateOperation_System_IProgress_System_Single__Cysharp_Threading_Tasks_PlayerLoopTiming_System_Threading_CancellationToken_System_Boolean_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.ToUniTask(UnityEngine.AsyncInstantiateOperation,System.IProgress{System.Single},Cysharp.Threading.Tasks.PlayerLoopTiming,System.Threading.CancellationToken,System.Boolean)">ToUniTask(AsyncInstantiateOperation, IProgress&lt;float&gt;, PlayerLoopTiming, CancellationToken, bool)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;Object[]&gt; ToUniTask(this AsyncInstantiateOperation asyncOperation, IProgress&lt;float&gt; progress = null, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span></dt>
<dd></dd>
<dt><span class="parametername"><code>progress</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>timing</code></span> <a class="xref" href="Cysharp.Threading.Tasks.PlayerLoopTiming.html">PlayerLoopTiming</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancelImmediately</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;<span class="xref">Object</span>[]&gt;</dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.ToUniTask*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_ToUniTask__1_UnityEngine_AsyncInstantiateOperation___0__System_IProgress_System_Single__Cysharp_Threading_Tasks_PlayerLoopTiming_System_Threading_CancellationToken_System_Boolean_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.ToUniTask``1(UnityEngine.AsyncInstantiateOperation{``0},System.IProgress{System.Single},Cysharp.Threading.Tasks.PlayerLoopTiming,System.Threading.CancellationToken,System.Boolean)">ToUniTask&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, IProgress&lt;float&gt;, PlayerLoopTiming, CancellationToken, bool)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;T[]&gt; ToUniTask&lt;T&gt;(this AsyncInstantiateOperation&lt;T&gt; asyncOperation, IProgress&lt;float&gt; progress = null, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false) where T : Object</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span>&lt;T&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>progress</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>timing</code></span> <a class="xref" href="Cysharp.Threading.Tasks.PlayerLoopTiming.html">PlayerLoopTiming</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancelImmediately</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T[]&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation``1(UnityEngine.AsyncInstantiateOperation,System.Threading.CancellationToken)">WithCancellation&lt;T&gt;(AsyncInstantiateOperation, CancellationToken)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;Object[]&gt; WithCancellation&lt;T&gt;(this AsyncInstantiateOperation asyncOperation, CancellationToken cancellationToken)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;<span class="xref">Object</span>[]&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation_System_Threading_CancellationToken_System_Boolean_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation``1(UnityEngine.AsyncInstantiateOperation,System.Threading.CancellationToken,System.Boolean)">WithCancellation&lt;T&gt;(AsyncInstantiateOperation, CancellationToken, bool)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;Object[]&gt; WithCancellation&lt;T&gt;(this AsyncInstantiateOperation asyncOperation, CancellationToken cancellationToken, bool cancelImmediately)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancelImmediately</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;<span class="xref">Object</span>[]&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation___0__System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation``1(UnityEngine.AsyncInstantiateOperation{``0},System.Threading.CancellationToken)">WithCancellation&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, CancellationToken)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;T[]&gt; WithCancellation&lt;T&gt;(this AsyncInstantiateOperation&lt;T&gt; asyncOperation, CancellationToken cancellationToken) where T : Object</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span>&lt;T&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T[]&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation*"></a>
<h4 id="Cysharp_Threading_Tasks_AsyncInstantiateOperationExtensions_WithCancellation__1_UnityEngine_AsyncInstantiateOperation___0__System_Threading_CancellationToken_System_Boolean_" data-uid="Cysharp.Threading.Tasks.AsyncInstantiateOperationExtensions.WithCancellation``1(UnityEngine.AsyncInstantiateOperation{``0},System.Threading.CancellationToken,System.Boolean)">WithCancellation&lt;T&gt;(AsyncInstantiateOperation&lt;T&gt;, CancellationToken, bool)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang- hljs">public static UniTask&lt;T[]&gt; WithCancellation&lt;T&gt;(this AsyncInstantiateOperation&lt;T&gt; asyncOperation, CancellationToken cancellationToken, bool cancelImmediately) where T : Object</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>asyncOperation</code></span> <span class="xref">AsyncInstantiateOperation</span>&lt;T&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><span class="parametername"><code>cancelImmediately</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T[]&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
</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>