-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update from TeamSTEP/Catch.io@1aa29ae
- Loading branch information
Showing
38 changed files
with
4,859 additions
and
782 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
249 changes: 249 additions & 0 deletions
249
api/CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,249 @@ | ||
<!DOCTYPE html> | ||
<!--[if IE]><![endif]--> | ||
<html> | ||
|
||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
<title>Class CharacterTrapSettingState | ||
| Catch.io Developer Reference </title> | ||
<meta name="viewport" content="width=device-width"> | ||
<meta name="title" content="Class CharacterTrapSettingState | ||
| Catch.io Developer Reference "> | ||
<meta name="generator" content="docfx 2.59.4.0"> | ||
<meta name="description" content="Developer documentation for Team STEP: Project Catch.io"> | ||
<link rel="shortcut icon" href="../resources/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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> | ||
<meta property="docfx:navrel" content="../toc.html"> | ||
<meta property="docfx:tocrel" content="toc.html"> | ||
|
||
<meta property="docfx:rel" content="../"> | ||
|
||
</head> <body data-spy="scroll" data-target="#affix" data-offset="120"> | ||
<div id="wrapper"> | ||
<header> | ||
|
||
<nav id="autocollapse" class="navbar navbar-inverse 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> | ||
|
||
<a class="navbar-brand" href="../index.html"> | ||
<img id="logo" class="svg" src="../logo.svg" alt=""> | ||
</a> | ||
</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 class="container body-content"> | ||
|
||
<div id="search-results"> | ||
<div class="search-list">Search Results for <span></span></div> | ||
<div class="sr-items"> | ||
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p> | ||
</div> | ||
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul> | ||
</div> | ||
</div> | ||
<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="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState"> | ||
|
||
|
||
<h1 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState" class="text-break">Class CharacterTrapSettingState | ||
</h1> | ||
<div class="markdown level0 summary"><p>Represents the state in which a character sets up a trap. | ||
Handles trap setup logic, including timing, inventory locking, and state transitions.</p> | ||
</div> | ||
<div class="markdown level0 conceptual"></div> | ||
<div class="inheritance"> | ||
<h5>Inheritance</h5> | ||
<div class="level0"><span class="xref">System.Object</span></div> | ||
<div class="level1"><a class="xref" href="CatchIo.Runtime.Character.FSM.States.CharacterBaseState.html">CharacterBaseState</a></div> | ||
<div class="level2"><a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html">CharacterActionState</a></div> | ||
<div class="level3"><span class="xref">CharacterTrapSettingState</span></div> | ||
</div> | ||
<div class="inheritedMembers"> | ||
<h5>Inherited Members</h5> | ||
<div> | ||
<a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html#CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterActionState_FixedUpdateState">CharacterActionState.FixedUpdateState()</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="CatchIo.Runtime.Character.FSM.States.CharacterBaseState.html#CatchIo_Runtime_Character_FSM_States_CharacterBaseState_StateMachine">CharacterBaseState.StateMachine</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="CatchIo.Runtime.Character.FSM.States.CharacterBaseState.html#CatchIo_Runtime_Character_FSM_States_CharacterBaseState_Factory">CharacterBaseState.Factory</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="CatchIo.Runtime.Character.FSM.States.CharacterBaseState.html#CatchIo_Runtime_Character_FSM_States_CharacterBaseState_EnteredStateTime">CharacterBaseState.EnteredStateTime</a> | ||
</div> | ||
</div> | ||
<h6><strong>Namespace</strong>: <a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.html">CatchIo.Runtime.Character.FSM.States.ActionStates</a></h6> | ||
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6> | ||
<h5 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_syntax">Syntax</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public class CharacterTrapSettingState : CharacterActionState</code></pre> | ||
</div> | ||
<h3 id="constructors">Constructors | ||
</h3> | ||
|
||
|
||
<a id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState__ctor_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.#ctor*"></a> | ||
<h4 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState__ctor_CatchIo_Runtime_Character_FSM_CharacterStateMachine_CatchIo_Runtime_Character_FSM_States_CharacterStateFactory_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.#ctor(CatchIo.Runtime.Character.FSM.CharacterStateMachine,CatchIo.Runtime.Character.FSM.States.CharacterStateFactory)">CharacterTrapSettingState(CharacterStateMachine, CharacterStateFactory)</h4> | ||
<div class="markdown level1 summary"><p>Initializes a new instance of the CharacterTrapSettingState class.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
<h5 class="decalaration">Declaration</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public CharacterTrapSettingState(CharacterStateMachine stateMachine, CharacterStateFactory factory)</code></pre> | ||
</div> | ||
<h5 class="parameters">Parameters</h5> | ||
<table class="table table-bordered table-striped table-condensed"> | ||
<thead> | ||
<tr> | ||
<th>Type</th> | ||
<th>Name</th> | ||
<th>Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><a class="xref" href="CatchIo.Runtime.Character.FSM.CharacterStateMachine.html">CharacterStateMachine</a></td> | ||
<td><span class="parametername">stateMachine</span></td> | ||
<td><p>The state machine controlling this state.</p> | ||
</td> | ||
</tr> | ||
<tr> | ||
<td><a class="xref" href="CatchIo.Runtime.Character.FSM.States.CharacterStateFactory.html">CharacterStateFactory</a></td> | ||
<td><span class="parametername">factory</span></td> | ||
<td><p>The factory used to create other states.</p> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<h3 id="methods">Methods | ||
</h3> | ||
|
||
|
||
<a id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_CheckSwitchStates_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.CheckSwitchStates*"></a> | ||
<h4 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_CheckSwitchStates" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.CheckSwitchStates">CheckSwitchStates()</h4> | ||
<div class="markdown level1 summary"><p>Checks conditions for transitioning to other states. | ||
Transitions to a static state if movement or certain inputs are detected.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
<h5 class="decalaration">Declaration</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public override void CheckSwitchStates()</code></pre> | ||
</div> | ||
<h5 class="overrides">Overrides</h5> | ||
<div><a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html#CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterActionState_CheckSwitchStates">CharacterActionState.CheckSwitchStates()</a></div> | ||
|
||
|
||
<a id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_EnterState_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.EnterState*"></a> | ||
<h4 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_EnterState" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.EnterState">EnterState()</h4> | ||
<div class="markdown level1 summary"><p>Called when entering the trap setting state. | ||
Initializes the setup process and locks the inventory.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
<h5 class="decalaration">Declaration</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public override void EnterState()</code></pre> | ||
</div> | ||
<h5 class="overrides">Overrides</h5> | ||
<div><a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html#CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterActionState_EnterState">CharacterActionState.EnterState()</a></div> | ||
|
||
|
||
<a id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_ExitState_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.ExitState*"></a> | ||
<h4 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_ExitState" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.ExitState">ExitState()</h4> | ||
<div class="markdown level1 summary"><p>Called when exiting the trap setting state. | ||
Cleans up resources and resets inventory and item display.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
<h5 class="decalaration">Declaration</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public override void ExitState()</code></pre> | ||
</div> | ||
<h5 class="overrides">Overrides</h5> | ||
<div><a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html#CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterActionState_ExitState">CharacterActionState.ExitState()</a></div> | ||
|
||
|
||
<a id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_UpdateState_" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.UpdateState*"></a> | ||
<h4 id="CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterTrapSettingState_UpdateState" data-uid="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterTrapSettingState.UpdateState">UpdateState()</h4> | ||
<div class="markdown level1 summary"><p>Updates the trap setting process each frame. | ||
Completes the setup after a specified time or transitions to another state if necessary.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
<h5 class="decalaration">Declaration</h5> | ||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public override void UpdateState()</code></pre> | ||
</div> | ||
<h5 class="overrides">Overrides</h5> | ||
<div><a class="xref" href="CatchIo.Runtime.Character.FSM.States.ActionStates.CharacterActionState.html#CatchIo_Runtime_Character_FSM_States_ActionStates_CharacterActionState_UpdateState">CharacterActionState.UpdateState()</a></div> | ||
</article> | ||
</div> | ||
|
||
<div class="hidden-sm col-md-2" role="complementary"> | ||
<div class="sideaffix"> | ||
<div class="contribution"> | ||
<ul class="nav"> | ||
</ul> | ||
</div> | ||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> | ||
<h5>In This Article</h5> | ||
<div></div> | ||
</nav> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<footer> | ||
<div class="grad-bottom"></div> | ||
<div class="footer"> | ||
<div class="container"> | ||
<span class="pull-right"> | ||
<a href="#top">Back to top</a> | ||
</span> | ||
©Team STEP, All Rights Reserved. | ||
|
||
</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/main.js"></script> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.