365 lines
18 KiB
HTML
365 lines
18 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>Time | @esengine/egret-framework</title>
|
||
<meta name="description" content="Documentation for @esengine/egret-framework">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="stylesheet" href="../assets/css/main.css">
|
||
</head>
|
||
<body>
|
||
<header>
|
||
<div class="tsd-page-toolbar">
|
||
<div class="container">
|
||
<div class="table-wrap">
|
||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||
<div class="field">
|
||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
<input id="tsd-search-field" type="text" />
|
||
</div>
|
||
<ul class="results">
|
||
<li class="state loading">Preparing search index...</li>
|
||
<li class="state failure">The search index is not available</li>
|
||
</ul>
|
||
<a href="../index.html" class="title">@esengine/egret-framework</a>
|
||
</div>
|
||
<div class="table-cell" id="tsd-widgets">
|
||
<div id="tsd-filter">
|
||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
<div class="tsd-filter-group">
|
||
<div class="tsd-select" id="tsd-filter-visibility">
|
||
<span class="tsd-select-label">All</span>
|
||
<ul class="tsd-select-list">
|
||
<li data-value="public">Public</li>
|
||
<li data-value="protected">Public/Protected</li>
|
||
<li data-value="private" class="selected">All</li>
|
||
</ul>
|
||
</div>
|
||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||
</div>
|
||
</div>
|
||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="tsd-page-title">
|
||
<div class="container">
|
||
<ul class="tsd-breadcrumb">
|
||
<li>
|
||
<a href="../globals.html">Globals</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_ecs_utils_time_.html">"ECS/Utils/Time"</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_ecs_utils_time_.es.html">es</a>
|
||
</li>
|
||
<li>
|
||
<a href="_ecs_utils_time_.es.time.html">Time</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class Time</h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>提供帧定时信息</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">Time</span>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<h2>Index</h2>
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<div class="tsd-index-content">
|
||
<section class="tsd-index-section ">
|
||
<h3>Properties</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_ecs_utils_time_.es.time.html#_lasttime" class="tsd-kind-icon">_last<wbr>Time</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#_timesincesceneload" class="tsd-kind-icon">_time<wbr>Since<wbr>Scene<wbr>Load</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#deltatime" class="tsd-kind-icon">delta<wbr>Time</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#framecount" class="tsd-kind-icon">frame<wbr>Count</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#timescale" class="tsd-kind-icon">time<wbr>Scale</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#unscaleddeltatime" class="tsd-kind-icon">unscaled<wbr>Delta<wbr>Time</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<h3>Methods</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#checkevery" class="tsd-kind-icon">check<wbr>Every</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#scenechanged" class="tsd-kind-icon">scene<wbr>Changed</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_time_.es.time.html#update" class="tsd-kind-icon">update</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Properties</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
||
<a name="_lasttime" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> _last<wbr>Time</h3>
|
||
<div class="tsd-signature tsd-kind-icon">_last<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L14">src/ECS/Utils/Time.ts:14</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a name="_timesincesceneload" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> _time<wbr>Since<wbr>Scene<wbr>Load</h3>
|
||
<div class="tsd-signature tsd-kind-icon">_time<wbr>Since<wbr>Scene<wbr>Load<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L13">src/ECS/Utils/Time.ts:13</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>自场景加载以来的总时间</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a name="deltatime" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> delta<wbr>Time</h3>
|
||
<div class="tsd-signature tsd-kind-icon">delta<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L7">src/ECS/Utils/Time.ts:7</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>前一帧到当前帧的时间增量，按时间刻度进行缩放</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a name="framecount" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> frame<wbr>Count</h3>
|
||
<div class="tsd-signature tsd-kind-icon">frame<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L11">src/ECS/Utils/Time.ts:11</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>已传递的帧总数</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a name="timescale" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> time<wbr>Scale</h3>
|
||
<div class="tsd-signature tsd-kind-icon">time<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L9">src/ECS/Utils/Time.ts:9</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>时间刻度缩放</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a name="unscaleddeltatime" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> unscaled<wbr>Delta<wbr>Time</h3>
|
||
<div class="tsd-signature tsd-kind-icon">unscaled<wbr>Delta<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L5">src/ECS/Utils/Time.ts:5</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>deltaTime的未缩放版本。不受时间尺度的影响</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Methods</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="checkevery" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> check<wbr>Every</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">check<wbr>Every<span class="tsd-signature-symbol">(</span>interval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L34">src/ECS/Utils/Time.ts:34</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>允许在间隔检查。只应该使用高于delta的间隔值，否则它将始终返回true。</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>interval: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="scenechanged" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> scene<wbr>Changed</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">scene<wbr>Changed<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L26">src/ECS/Utils/Time.ts:26</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="update" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> update</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/Time.ts#L16">src/ECS/Utils/Time.ts:16</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>currentTime: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<nav class="tsd-navigation primary">
|
||
<ul>
|
||
<li class="globals ">
|
||
<a href="../globals.html"><em>Globals</em></a>
|
||
</li>
|
||
<li class="current tsd-kind-module">
|
||
<a href="../modules/_ecs_utils_time_.html">"ECS/<wbr>Utils/<wbr>Time"</a>
|
||
<ul>
|
||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||
<a href="../modules/_ecs_utils_time_.es.html">es</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul class="before-current">
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
||
<a href="_ecs_utils_time_.es.time.html" class="tsd-kind-icon">Time</a>
|
||
<ul>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#_lasttime" class="tsd-kind-icon">_last<wbr>Time</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#_timesincesceneload" class="tsd-kind-icon">_time<wbr>Since<wbr>Scene<wbr>Load</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#deltatime" class="tsd-kind-icon">delta<wbr>Time</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#framecount" class="tsd-kind-icon">frame<wbr>Count</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#timescale" class="tsd-kind-icon">time<wbr>Scale</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#unscaleddeltatime" class="tsd-kind-icon">unscaled<wbr>Delta<wbr>Time</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#checkevery" class="tsd-kind-icon">check<wbr>Every</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#scenechanged" class="tsd-kind-icon">scene<wbr>Changed</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_ecs_utils_time_.es.time.html#update" class="tsd-kind-icon">update</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="after-current">
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<footer class="with-border-bottom">
|
||
<div class="container">
|
||
<h2>Legend</h2>
|
||
<div class="tsd-legend-group">
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<div class="container tsd-generator">
|
||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
</div>
|
||
<div class="overlay"></div>
|
||
<script src="../assets/js/main.js"></script>
|
||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||
</body>
|
||
</html> |