Skip to content

Commit

Permalink
Deployed 4d824b1 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@hfjooste
hfjooste committed Nov 16, 2023
1 parent 1fbc6fb commit e3528ec
Show file tree
Hide file tree
Showing 8 changed files with 373 additions and 122 deletions.
222 changes: 222 additions & 0 deletions characteranimationinstance/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2877,6 +2877,114 @@ <h3 id="properties">Properties</h3>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>IdleWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is in the idle state with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>WalkWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is walking with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>RunWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is running with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SprintWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is sprinting with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>JumpWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is jumping with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>DoubleJumpWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is double jumping with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>FallWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is falling with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>LandWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is landing with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchStartWeaponAimOneHandedAnimation</td>
<td>The animation used when the character starts crouching with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchEndWeaponAimOneHandedAnimation</td>
<td>The animation used when the character stops crouching with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchIdleWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is crouching and idle with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchWalkWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is crouching and walking with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompStartWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is starting to stomp with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompFallWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is falling after a stomp with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompLandWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is landing after a stomp with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideStartWeaponAimOneHandedAnimation</td>
<td>The animation used when the character starts sliding with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideEndWeaponAimOneHandedAnimation</td>
<td>The animation used when the character stops sliding with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideLoopWeaponAimOneHandedAnimation</td>
<td>The animation used when the character is sliding with a one handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>IdleWeaponTwoHandedAnimation</td>
<td>The animation used when the character is in the idle state with a two handed weapon</td>
Expand Down Expand Up @@ -2985,6 +3093,114 @@ <h3 id="properties">Properties</h3>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>IdleWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is in the idle state with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>WalkWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is walking with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>RunWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is running with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SprintWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is sprinting with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>JumpWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is jumping with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>DoubleJumpWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is double jumping with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>FallWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is falling with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>LandWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is landing with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchStartWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character starts crouching with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchEndWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character stops crouching with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchIdleWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is crouching and idle with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchWalkWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is crouching and walking with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompStartWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is starting to stomp with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompFallWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is falling after a stomp with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>StompLandWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is landing after a stomp with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideStartWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character starts sliding with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideEndWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character stops sliding with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SlideLoopWeaponAimTwoHandedAnimation</td>
<td>The animation used when the character is sliding with a two handed weapon while aiming</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>MovementBlendSpeed</td>
<td>The blend speed used when updating the movement speed</td>
Expand Down Expand Up @@ -3063,6 +3279,12 @@ <h3 id="properties">Properties</h3>
<td>bool</td>
<td></td>
</tr>
<tr>
<td>bIsAiming</td>
<td>Is the character aiming?</td>
<td>bool</td>
<td></td>
</tr>
</table>

<h3 id="functions">Functions</h3>
Expand Down
25 changes: 0 additions & 25 deletions fpscharacter/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1200,13 +1200,6 @@
Introduction
</a>

</li>

<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2545,13 +2538,6 @@
Introduction
</a>

</li>

<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2590,17 +2576,6 @@ <h1>FPS Character</h1>

<h2 id="introduction">Introduction</h2>
<p>Base character that can be used for first person shooter (FPS) games</p>
<h2 id="features">Features</h2>
<p>The following features are included in the FPS character class:</p>
<ol>
<li><strong>Double Jumping</strong>: Additional jump with a different jump animation</li>
<li><strong>Variable Jump Height</strong>: Adjust jump height based on how long the jump button is pressed</li>
<li><strong>Coyote Time</strong>: Allow the character to jump for a short time after falling off the platform</li>
<li><strong>Shadow Decal</strong>: A decal used as a shadow to indicate where the character will land</li>
<li><strong>Jump & Land effects</strong>: Sound effects and particles when jumping and landing</li>
</ol>

<p>All these features can be configured to meet your needs and can also be disabled</p>
<h2 id="api-reference">API Reference</h2>
<h2 id="blueprint-usage">Blueprint Usage</h2>
<p>There is no additional functions exposed to Blueprints. Just create the character and add it to your level</p>
Expand Down
Binary file modified pdf/document.pdf
View file
Binary file not shown.
26 changes: 0 additions & 26 deletions platformercharacter/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1227,13 +1227,6 @@
Dependencies
</a>

</li>

<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2586,13 +2579,6 @@
Dependencies
</a>

</li>

<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2664,18 +2650,6 @@ <h2 id="dependencies">Dependencies</h2>
<li><a href="../logger">Logger</a>: Used to log useful information to help you debug any issues you might experience</li>
</ul>

<h2 id="features">Features</h2>
<p>The following features are included in the 3D platformer character class:</p>
<ol>
<li><strong>Double Jumping</strong>: Additional jump with a different jump animation</li>
<li><strong>Variable Jump Height</strong>: Adjust jump height based on how long the jump button is pressed</li>
<li><strong>Coyote Time</strong>: Allow the character to jump for a short time after falling off the platform</li>
<li><strong>Shadow Decal</strong>: A decal used as a shadow to indicate where the character will land</li>
<li><strong>Adjustable Camera Distance</strong>: The camera automatically zooms in on the character while idle and zooms out as soon as the character starts moving</li>
<li><strong>Jump & Land effects</strong>: Sound effects and particles when jumping and landing</li>
</ol>

<p>All these features can be configured to meet your needs and can also be disabled</p>
<h2 id="components">Components</h2>
<p>The <code>PlatformerCharacter</code> uses the following components:</p>
<table>
Expand Down
Loading

0 comments on commit e3528ec

Please sign in to comment.