Skip to content

Commit

Permalink
Deployed dda353b with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
hfjooste committed Mar 23, 2024
1 parent fed9ded commit d2eeba3
Show file tree
Hide file tree
Showing 9 changed files with 203 additions and 76 deletions.
54 changes: 54 additions & 0 deletions characteranimationinstance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2872,12 +2872,24 @@ <h3 id="properties">Properties</h3>
<td>bool</td>
<td>true</td>
</tr>
<tr>
<td>bEnableDirectionalMovementAnimations</td>
<td>Should directional movement animations be used?</td>
<td>bool</td>
<td>false</td>
</tr>
<tr>
<td>IdleBaseAnimation</td>
<td>The base animation used when the character is in the idle state</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>WalkBaseAnimation</td>
<td>The base animation used when the character is walking</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>WalkForwardBaseAnimation</td>
<td>The base animation used when the character is walking forward</td>
Expand All @@ -2902,6 +2914,12 @@ <h3 id="properties">Properties</h3>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>RunBaseAnimation</td>
<td>The base animation used when the character is running</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>RunForwardBaseAnimation</td>
<td>The base animation used when the character is running forward</td>
Expand All @@ -2926,6 +2944,12 @@ <h3 id="properties">Properties</h3>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SprintBaseAnimation</td>
<td>The base animation used when the character is sprinting</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>SprintForwardBaseAnimation</td>
<td>The base animation used when the character is sprinting forward</td>
Expand Down Expand Up @@ -2992,6 +3016,12 @@ <h3 id="properties">Properties</h3>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchWalkBaseAnimation</td>
<td>The base animation used when the character is crouching and walking</td>
<td>UAnimSequence*</td>
<td><code>nullptr</code></td>
</tr>
<tr>
<td>CrouchWalkForwardBaseAnimation</td>
<td>The base animation used when the character is crouching and walking forward</td>
Expand Down Expand Up @@ -3890,6 +3920,12 @@ <h3 id="functions">Functions</h3>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The idle animation to play</td>
</tr>
<tr>
<td>GetWalkBaseAnimation</td>
<td>Get the base walk animation</td>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The walk animation to play</td>
</tr>
<tr>
<td>GetWalkForwardBaseAnimation</td>
<td>Get the base walk forward animation</td>
Expand All @@ -3914,6 +3950,12 @@ <h3 id="functions">Functions</h3>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The walk right animation to play</td>
</tr>
<tr>
<td>GetRunBaseAnimation</td>
<td>Get the base run animation</td>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The run animation to play</td>
</tr>
<tr>
<td>GetRunForwardBaseAnimation</td>
<td>Get the base run forward animation</td>
Expand All @@ -3938,6 +3980,12 @@ <h3 id="functions">Functions</h3>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The run right animation to play</td>
</tr>
<tr>
<td>GetSprintBaseAnimation</td>
<td>Get the base sprint animation</td>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The sprint animation to play</td>
</tr>
<tr>
<td>GetSprintForwardBaseAnimation</td>
<td>Get the base sprint forward animation</td>
Expand Down Expand Up @@ -4004,6 +4052,12 @@ <h3 id="functions">Functions</h3>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The crouch idle animation to play</td>
</tr>
<tr>
<td>GetCrouchWalkBaseAnimation</td>
<td>Get the base crouch walk animation</td>
<td></td>
<td><strong>UAnimSequence*</strong><br/>The crouch walk animation to play</td>
</tr>
<tr>
<td>GetCrouchWalkForwardBaseAnimation</td>
<td>Get the base crouch walk forward animation</td>
Expand Down
21 changes: 21 additions & 0 deletions gameinstance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3032,6 +3032,11 @@ <h3 id="events">Events</h3>
<td>Event used to notify other classes when the game is unpaused</td>
<td></td>
</tr>
<tr>
<td>OnDifficultyUpdated</td>
<td>Event used to notify other classes when the difficulty is updated</td>
<td><strong>Difficulty (int)</strong><br/>The new difficulty value</td>
</tr>
</table>

<h3 id="functions">Functions</h3>
Expand Down Expand Up @@ -3114,6 +3119,18 @@ <h3 id="functions">Functions</h3>
<td></td>
<td></td>
</tr>
<tr>
<td>UpdateDifficulty</td>
<td>Update the difficulty</td>
<td><strong>Difficulty (int)</strong><br/>The new difficulty</td>
<td></td>
</tr>
<tr>
<td>GetDifficulty</td>
<td>Get the current difficulty</td>
<td></td>
<td><strong>int</strong><br/>The current difficulty</td>
</tr>
<tr>
<td>ShowMessagePopup</td>
<td>Show a message popup</td>
Expand Down Expand Up @@ -3143,6 +3160,8 @@ <h2 id="blueprint-usage">Blueprint Usage</h2>
<li>Ultimate Starter Kit > Input > Update Key Bindings</li>
<li>Ultimate Starter Kit > Pause > Pause Game</li>
<li>Ultimate Starter Kit > Pause > Unpause Game</li>
<li>Ultimate Starter Kit > Difficulty > Update Difficulty</li>
<li>Ultimate Starter Kit > Difficulty > Get Difficulty</li>
<li>Ultimate Starter Kit > UI > Show Message Popup</li>
<li>Ultimate Starter Kit > UI > Hide Message Popup</li>
</ul>
Expand All @@ -3169,6 +3188,8 @@ <h2 id="c-usage">C++ Usage</h2>
USKGameInstance-&gt;UpdateKeyBindings();
USKGameInstance-&gt;PauseGame();
USKGameInstance-&gt;UnpauseGame();
USKGameInstance-&gt;UpdateDifficulty(Difficulty);
int Difficulty = USKGameInstance-&gt;GetDifficulty();
UMessagePopupWidget* ShowMessagePopupValue = USKGameInstance-&gt;ShowMessagePopup(Data);
USKGameInstance-&gt;HideMessagePopup();
}
Expand Down
Binary file modified pdf/document.pdf
Binary file not shown.
24 changes: 24 additions & 0 deletions settingsconfig/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2784,6 +2784,30 @@ <h3 id="properties">Properties</h3>
<th>Type</th>
<th>Default Value</th>
</tr>
<tr>
<td>GameplayDifficultyImplementation</td>
<td>The implementation for the gameplay difficulty setting</td>
<td>TSubclassOf&lt;USettingsItem&gt;</td>
<td>USettingsItemGameplayDifficulty::StaticClas</td>
</tr>
<tr>
<td>GameplayDifficultyText</td>
<td>The text displayed in the gameplay difficulty settings item</td>
<td>FText</td>
<td></td>
</tr>
<tr>
<td>GameplayDifficultyOptions</td>
<td>The array of gameplay difficulty options</td>
<td>TArray&lt;FText&gt;</td>
<td></td>
</tr>
<tr>
<td>GameplayDifficultyDefault</td>
<td>The default gameplay difficulty value</td>
<td>int</td>
<td>0</td>
</tr>
<tr>
<td>AudioMasterImplementation</td>
<td>The implementation for the audio master settings item</td>
Expand Down
12 changes: 12 additions & 0 deletions settingsdata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2784,6 +2784,18 @@ <h3 id="properties">Properties</h3>
<th>Type</th>
<th>Default Value</th>
</tr>
<tr>
<td>GameplayDifficultyModified</td>
<td>Was the gameplay difficulty setting modified?</td>
<td>bool</td>
<td>false</td>
</tr>
<tr>
<td>GameplayDifficulty</td>
<td>The gameplay difficulty setting</td>
<td>int</td>
<td></td>
</tr>
<tr>
<td>AudioMasterModified</td>
<td>Was the master audio volume modified?</td>
Expand Down
4 changes: 4 additions & 0 deletions settingsitemtype/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2761,6 +2761,10 @@ <h2 id="values">Values</h2>
<td>None</td>
<td>A setting not managed by the game instance</td>
</tr>
<tr>
<td>GameplayDifficulty</td>
<td>The game difficulty setting</td>
</tr>
<tr>
<td>AudioMaster</td>
<td>The master audio volume setting</td>
Expand Down
Loading

0 comments on commit d2eeba3

Please sign in to comment.