378 lines
19 KiB
HTML
378 lines
19 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>Action | @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/_ai_pathfinding_goap_action_.html">"AI/Pathfinding/GOAP/Action"</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_ai_pathfinding_goap_action_.es.html">es</a>
|
||
</li>
|
||
<li>
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html">Action</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class Action</h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">Action</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>Constructors</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<h3>Properties</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#_postconditions" class="tsd-kind-icon">_post<wbr>Conditions</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#_preconditions" class="tsd-kind-icon">_pre<wbr>Conditions</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#cost" class="tsd-kind-icon">cost</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#name" class="tsd-kind-icon">name</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"><a href="_ai_pathfinding_goap_action_.es.action.html#setpostcondition" class="tsd-kind-icon">set<wbr>Postcondition</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#setprecondition" class="tsd-kind-icon">set<wbr>Precondition</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_ai_pathfinding_goap_action_.es.action.html#validate" class="tsd-kind-icon">validate</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Constructors</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||
<a name="constructor" class="tsd-anchor"></a>
|
||
<h3>constructor</h3>
|
||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">new <wbr>Action<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, cost<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><a href="_ai_pathfinding_goap_action_.es.action.html" class="tsd-signature-type">Action</a></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/AI/Pathfinding/GOAP/Action.ts#L14">src/AI/Pathfinding/GOAP/Action.ts:14</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> cost: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <a href="_ai_pathfinding_goap_action_.es.action.html" class="tsd-signature-type">Action</a></h4>
|
||
</li>
|
||
</ul>
|
||
</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">
|
||
<a name="_postconditions" class="tsd-anchor"></a>
|
||
<h3>_post<wbr>Conditions</h3>
|
||
<div class="tsd-signature tsd-kind-icon">_post<wbr>Conditions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Set<[string, boolean]>()</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/AI/Pathfinding/GOAP/Action.ts#L14">src/AI/Pathfinding/GOAP/Action.ts:14</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
<a name="_preconditions" class="tsd-anchor"></a>
|
||
<h3>_pre<wbr>Conditions</h3>
|
||
<div class="tsd-signature tsd-kind-icon">_pre<wbr>Conditions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Set<[string, boolean]>()</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/AI/Pathfinding/GOAP/Action.ts#L13">src/AI/Pathfinding/GOAP/Action.ts:13</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
<a name="cost" class="tsd-anchor"></a>
|
||
<h3>cost</h3>
|
||
<div class="tsd-signature tsd-kind-icon">cost<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/AI/Pathfinding/GOAP/Action.ts#L11">src/AI/Pathfinding/GOAP/Action.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">
|
||
<a name="name" class="tsd-anchor"></a>
|
||
<h3>name</h3>
|
||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/AI/Pathfinding/GOAP/Action.ts#L6">src/AI/Pathfinding/GOAP/Action.ts:6</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Action的可选名称。用于调试目的</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">
|
||
<a name="setpostcondition" class="tsd-anchor"></a>
|
||
<h3>set<wbr>Postcondition</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">set<wbr>Postcondition<span class="tsd-signature-symbol">(</span>conditionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/AI/Pathfinding/GOAP/Action.ts#L25">src/AI/Pathfinding/GOAP/Action.ts:25</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>conditionName: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
</ul>
|
||
<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">
|
||
<a name="setprecondition" class="tsd-anchor"></a>
|
||
<h3>set<wbr>Precondition</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">set<wbr>Precondition<span class="tsd-signature-symbol">(</span>conditionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/AI/Pathfinding/GOAP/Action.ts#L21">src/AI/Pathfinding/GOAP/Action.ts:21</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>conditionName: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
</ul>
|
||
<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">
|
||
<a name="tostring" class="tsd-anchor"></a>
|
||
<h3>to<wbr>String</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/AI/Pathfinding/GOAP/Action.ts#L37">src/AI/Pathfinding/GOAP/Action.ts:37</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
<a name="validate" class="tsd-anchor"></a>
|
||
<h3>validate</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</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/AI/Pathfinding/GOAP/Action.ts#L33">src/AI/Pathfinding/GOAP/Action.ts:33</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>在ActionPlanner进行plan之前调用。让Action有机会设置它的分数，或者在没有用的情况下选择退出。
|
||
例如，如果Action是要拿起一把枪，但世界上没有枪，返回false将使Action不被ActionPlanner考虑</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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/_ai_pathfinding_goap_action_.html">"AI/<wbr>Pathfinding/GOAP/<wbr>Action"</a>
|
||
<ul>
|
||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||
<a href="../modules/_ai_pathfinding_goap_action_.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="_ai_pathfinding_goap_action_.es.action.html" class="tsd-kind-icon">Action</a>
|
||
<ul>
|
||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#constructor" class="tsd-kind-icon">constructor</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#_postconditions" class="tsd-kind-icon">_post<wbr>Conditions</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#_preconditions" class="tsd-kind-icon">_pre<wbr>Conditions</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#cost" class="tsd-kind-icon">cost</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#name" class="tsd-kind-icon">name</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#setpostcondition" class="tsd-kind-icon">set<wbr>Postcondition</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#setprecondition" class="tsd-kind-icon">set<wbr>Precondition</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_ai_pathfinding_goap_action_.es.action.html#validate" class="tsd-kind-icon">validate</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-class"><span class="tsd-kind-icon">Class</span></li>
|
||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||
</ul>
|
||
<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-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</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> |