Skip to content

Commit d9122c0

Browse files
committed
deploy: a8f9772
1 parent 81c15b4 commit d9122c0

198 files changed

Lines changed: 3063 additions & 2642 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api/GameFrameX.Core.Abstractions.Agent.IComponentAgent.html

Lines changed: 155 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<meta name="docfx:rel" content="../">
1717

1818

19-
<meta name="docfx:docurl" content="https://github.com/GameFrameX/GameFrameX.Server/new/1.5.1-dev29/apiSpec/new?filename=GameFrameX_Core_Abstractions_Agent_IComponentAgent.md&amp;value=---%0Auid%3A%20GameFrameX.Core.Abstractions.Agent.IComponentAgent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
19+
<meta name="docfx:docurl" content="https://github.com/GameFrameX/GameFrameX.Server/new/1.5.1-dev30/apiSpec/new?filename=GameFrameX_Core_Abstractions_Agent_IComponentAgent.md&amp;value=---%0Auid%3A%20GameFrameX.Core.Abstractions.Agent.IComponentAgent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
2020
<meta name="loc:inThisArticle" content="In this article">
2121
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
2222
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8989

9090

9191
<h1 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent" class="text-break">
92-
Interface IComponentAgent <a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L6"><i class="bi bi-code-slash"></i></a>
92+
Interface IComponentAgent <a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L6"><i class="bi bi-code-slash"></i></a>
9393
</h1>
9494

9595
<div class="facts text-secondary">
@@ -163,7 +163,7 @@ <h2 class="section" id="properties">Properties
163163

164164
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_ActorId" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.ActorId">
165165
ActorId
166-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L14"><i class="bi bi-code-slash"></i></a>
166+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L14"><i class="bi bi-code-slash"></i></a>
167167
</h3>
168168

169169
<div class="markdown level1 summary"><p>获取Actor的唯一标识
@@ -198,7 +198,7 @@ <h4 class="section">Property Value</h4>
198198

199199
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_Owner" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.Owner">
200200
Owner
201-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L22"><i class="bi bi-code-slash"></i></a>
201+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L22"><i class="bi bi-code-slash"></i></a>
202202
</h3>
203203

204204
<div class="markdown level1 summary"><p>获取或设置组件的所有者
@@ -233,7 +233,7 @@ <h4 class="section">Property Value</h4>
233233

234234
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_OwnerType" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.OwnerType">
235235
OwnerType
236-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L30"><i class="bi bi-code-slash"></i></a>
236+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L30"><i class="bi bi-code-slash"></i></a>
237237
</h3>
238238

239239
<div class="markdown level1 summary"><p>获取所有者的类型
@@ -272,7 +272,7 @@ <h2 class="section" id="methods">Methods
272272

273273
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_Active" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.Active">
274274
Active()
275-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L47"><i class="bi bi-code-slash"></i></a>
275+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L56"><i class="bi bi-code-slash"></i></a>
276276
</h3>
277277

278278
<div class="markdown level1 summary"><p>激活组件代理
@@ -303,11 +303,155 @@ <h4 class="section">Returns</h4>
303303

304304

305305

306+
<a id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterActivation_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.AfterActivation*"></a>
307+
308+
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterActivation" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.AfterActivation">
309+
AfterActivation()
310+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L65"><i class="bi bi-code-slash"></i></a>
311+
</h3>
312+
313+
<div class="markdown level1 summary"><p>组件激活后的回调方法</p>
314+
</div>
315+
<div class="markdown level1 conceptual"></div>
316+
317+
<div class="codewrapper">
318+
<pre><code class="lang-csharp hljs">Task AfterActivation()</code></pre>
319+
</div>
320+
321+
322+
<h4 class="section">Returns</h4>
323+
<dl class="parameters">
324+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
325+
<dd><p>表示异步操作的任务</p>
326+
</dd>
327+
</dl>
328+
329+
330+
331+
332+
333+
334+
335+
<h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterActivation_remarks">Remarks</h4>
336+
<div class="markdown level1 remarks"><p>在组件完成激活流程后执行,可以用于处理一些初始化后的逻辑</p>
337+
</div>
338+
339+
340+
341+
342+
<a id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterInActivation_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.AfterInActivation*"></a>
343+
344+
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterInActivation" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.AfterInActivation">
345+
AfterInActivation()
346+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L92"><i class="bi bi-code-slash"></i></a>
347+
</h3>
348+
349+
<div class="markdown level1 summary"><p>组件反激活后的回调方法</p>
350+
</div>
351+
<div class="markdown level1 conceptual"></div>
352+
353+
<div class="codewrapper">
354+
<pre><code class="lang-csharp hljs">Task AfterInActivation()</code></pre>
355+
</div>
356+
357+
358+
<h4 class="section">Returns</h4>
359+
<dl class="parameters">
360+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
361+
<dd><p>表示异步操作的任务</p>
362+
</dd>
363+
</dl>
364+
365+
366+
367+
368+
369+
370+
371+
<h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_AfterInActivation_remarks">Remarks</h4>
372+
<div class="markdown level1 remarks"><p>在组件完成反激活流程后执行,可以用于确认清理完成或执行最终操作</p>
373+
</div>
374+
375+
376+
377+
378+
<a id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeActivation_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.BeforeActivation*"></a>
379+
380+
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeActivation" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.BeforeActivation">
381+
BeforeActivation()
382+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L48"><i class="bi bi-code-slash"></i></a>
383+
</h3>
384+
385+
<div class="markdown level1 summary"><p>组件激活前的回调方法</p>
386+
</div>
387+
<div class="markdown level1 conceptual"></div>
388+
389+
<div class="codewrapper">
390+
<pre><code class="lang-csharp hljs">Task BeforeActivation()</code></pre>
391+
</div>
392+
393+
394+
<h4 class="section">Returns</h4>
395+
<dl class="parameters">
396+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
397+
<dd><p>表示异步操作的任务</p>
398+
</dd>
399+
</dl>
400+
401+
402+
403+
404+
405+
406+
407+
<h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeActivation_remarks">Remarks</h4>
408+
<div class="markdown level1 remarks"><p>在组件开始激活流程前执行,可以用于进行一些预处理操作</p>
409+
</div>
410+
411+
412+
413+
414+
<a id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeInActivation_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.BeforeInActivation*"></a>
415+
416+
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeInActivation" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.BeforeInActivation">
417+
BeforeInActivation()
418+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L74"><i class="bi bi-code-slash"></i></a>
419+
</h3>
420+
421+
<div class="markdown level1 summary"><p>组件反激活前的回调方法</p>
422+
</div>
423+
<div class="markdown level1 conceptual"></div>
424+
425+
<div class="codewrapper">
426+
<pre><code class="lang-csharp hljs">Task BeforeInActivation()</code></pre>
427+
</div>
428+
429+
430+
<h4 class="section">Returns</h4>
431+
<dl class="parameters">
432+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
433+
<dd><p>表示异步操作的任务</p>
434+
</dd>
435+
</dl>
436+
437+
438+
439+
440+
441+
442+
443+
<h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_BeforeInActivation_remarks">Remarks</h4>
444+
<div class="markdown level1 remarks"><p>在组件开始反激活流程前执行,可以用于保存状态或清理资源</p>
445+
</div>
446+
447+
448+
449+
306450
<a id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_GetComponentAgent_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.GetComponentAgent*"></a>
307451

308452
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_GetComponentAgent_System_Type_System_Boolean_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.GetComponentAgent(System.Type,System.Boolean)">
309453
GetComponentAgent(Type, bool)
310-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L67"><i class="bi bi-code-slash"></i></a>
454+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L103"><i class="bi bi-code-slash"></i></a>
311455
</h3>
312456

313457
<div class="markdown level1 summary"><p>根据代理类型获取代理组件</p>
@@ -352,7 +496,7 @@ <h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_GetCo
352496

353497
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_GetComponentAgent__1_System_Boolean_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.GetComponentAgent``1(System.Boolean)">
354498
GetComponentAgent&lt;T&gt;(bool)
355-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L78"><i class="bi bi-code-slash"></i></a>
499+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L114"><i class="bi bi-code-slash"></i></a>
356500
</h3>
357501

358502
<div class="markdown level1 summary"><p>根据泛型代理类型获取代理组件</p>
@@ -400,7 +544,7 @@ <h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_GetCo
400544

401545
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_Inactive" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.Inactive">
402546
Inactive()
403-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L56"><i class="bi bi-code-slash"></i></a>
547+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L83"><i class="bi bi-code-slash"></i></a>
404548
</h3>
405549

406550
<div class="markdown level1 summary"><p>反激活组件代理</p>
@@ -436,7 +580,7 @@ <h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_Inact
436580

437581
<h3 id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_SetOwner_GameFrameX_Core_Abstractions_IComponent_" data-uid="GameFrameX.Core.Abstractions.Agent.IComponentAgent.SetOwner(GameFrameX.Core.Abstractions.IComponent)">
438582
SetOwner(IComponent)
439-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L39"><i class="bi bi-code-slash"></i></a>
583+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L39"><i class="bi bi-code-slash"></i></a>
440584
</h3>
441585

442586
<div class="markdown level1 summary"><p>设置组件的所有者</p>
@@ -472,7 +616,7 @@ <h4 class="section" id="GameFrameX_Core_Abstractions_Agent_IComponentAgent_SetOw
472616
</article>
473617

474618
<div class="contribution d-print-none">
475-
<a href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L6" class="edit-link">Edit this page</a>
619+
<a href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Agent/IComponentAgent.cs/#L6" class="edit-link">Edit this page</a>
476620
</div>
477621

478622

api/GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<meta name="docfx:rel" content="../">
1717

1818

19-
<meta name="docfx:docurl" content="https://github.com/GameFrameX/GameFrameX.Server/new/1.5.1-dev29/apiSpec/new?filename=GameFrameX_Core_Abstractions_Attribute_ComponentTypeAttribute.md&amp;value=---%0Auid%3A%20GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
19+
<meta name="docfx:docurl" content="https://github.com/GameFrameX/GameFrameX.Server/new/1.5.1-dev30/apiSpec/new?filename=GameFrameX_Core_Abstractions_Attribute_ComponentTypeAttribute.md&amp;value=---%0Auid%3A%20GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
2020
<meta name="loc:inThisArticle" content="In this article">
2121
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
2222
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8989

9090

9191
<h1 id="GameFrameX_Core_Abstractions_Attribute_ComponentTypeAttribute" data-uid="GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute" class="text-break">
92-
Class ComponentTypeAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L8"><i class="bi bi-code-slash"></i></a>
92+
Class ComponentTypeAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L8"><i class="bi bi-code-slash"></i></a>
9393
</h1>
9494

9595
<div class="facts text-secondary">
@@ -280,7 +280,7 @@ <h2 class="section" id="constructors">Constructors
280280

281281
<h3 id="GameFrameX_Core_Abstractions_Attribute_ComponentTypeAttribute__ctor_System_UInt16_" data-uid="GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute.#ctor(System.UInt16)">
282282
ComponentTypeAttribute(ushort)
283-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L15"><i class="bi bi-code-slash"></i></a>
283+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L15"><i class="bi bi-code-slash"></i></a>
284284
</h3>
285285

286286
<div class="markdown level1 summary"><p>组件类型</p>
@@ -317,7 +317,7 @@ <h2 class="section" id="properties">Properties
317317

318318
<h3 id="GameFrameX_Core_Abstractions_Attribute_ComponentTypeAttribute_Type" data-uid="GameFrameX.Core.Abstractions.Attribute.ComponentTypeAttribute.Type">
319319
Type
320-
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L28"><i class="bi bi-code-slash"></i></a>
320+
<a class="header-action link-secondary" title="View source" href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L28"><i class="bi bi-code-slash"></i></a>
321321
</h3>
322322

323323
<div class="markdown level1 summary"><p>组件类型</p>
@@ -349,7 +349,7 @@ <h4 class="section">Property Value</h4>
349349
</article>
350350

351351
<div class="contribution d-print-none">
352-
<a href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev29/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L8" class="edit-link">Edit this page</a>
352+
<a href="https://github.com/GameFrameX/GameFrameX.Server/blob/1.5.1-dev30/GameFrameX.Core/Abstractions/Attribute/ComponentTypeAttribute.cs/#L8" class="edit-link">Edit this page</a>
353353
</div>
354354

355355

0 commit comments

Comments
 (0)