Skip to content

Commit

Permalink
Update documentation for 1.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Razdvizh committed Nov 11, 2024
1 parent 097e6b5 commit f7b41ff
Show file tree
Hide file tree
Showing 148 changed files with 1,697 additions and 468 deletions.
2 changes: 1 addition & 1 deletion VisualU.uplugin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.1",
"VersionName": "1.2",
"FriendlyName": "VisualU",
"Description": "Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel narrative",
"Category": "Other",
Expand Down
2 changes: 1 addition & 1 deletion docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_f_break_visual_text_block_decorator.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -119,7 +119,7 @@
<p>Pauses typewriter when it hits break tag - <code class="JavaDocCode">&lt;b/&gt;</code>.
<a href="#details">More...</a></p>

<p><code>#include &lt;BreakVisualTextBlockDecorator.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/BreakVisualTextBlockDecorator.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FBreakVisualTextBlockDecorator:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_f_visual_u_module-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_f_visual_u_module.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -115,7 +115,7 @@
<p><a class="el" href="class_visual_u.html">VisualU</a> plugin runtime module.
<a href="#details">More...</a></p>

<p><code>#include &lt;VisualU.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualU.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FVisualUModule:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_has_member_of_type_impl-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_has_member_of_type_impl.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -116,7 +116,7 @@
<p>Checks if T has a member variable of type U.
<a href="#details">More...</a></p>

<p><code>#include &lt;VisualTemplates.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualTemplates.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_i_info_assignable.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -112,7 +112,7 @@
<p>Interface that allows classes to take data from <a class="el" href="struct_f_visual_info.html" title="Base struct for assignable info.">FVisualInfo</a> structures.
<a href="#details">More...</a></p>

<p><code>#include &lt;InfoAssignable.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/InfoAssignable.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IInfoAssignable:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_i_visual_controller_interface-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_i_visual_controller_interface.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -115,7 +115,7 @@
<p>Indicates that the class has access to <a class="el" href="class_u_visual_controller.html" title="Organizes scenes described by FScenario in a meaningful way.">UVisualController</a>.
<a href="#details">More...</a></p>

<p><code>#include &lt;VisualControllerInterface.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualControllerInterface.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_s_background_visual_image-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_s_background_visual_image.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -118,7 +118,7 @@
<p>Slate visual image that supports transition effects through material.
<a href="#details">More...</a></p>

<p><code>#include &lt;SBackgroundVisualImage.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SBackgroundVisualImage.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SBackgroundVisualImage:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_s_visual_image-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_s_visual_image.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -117,7 +117,7 @@
<p>Slate widget that displays sprite flipbooks.
<a href="#details">More...</a></p>

<p><code>#include &lt;SVisualImage.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SVisualImage.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SVisualImage:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_s_visual_image_base-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_s_visual_image_base.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -117,7 +117,7 @@
<p>Base slate class for widgets that can display some render resource.
<a href="#details">More...</a></p>

<p><code>#include &lt;SVisualImageBase.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SVisualImageBase.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SVisualImageBase&lt; DerivedT &gt;:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_s_visual_socket-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_s_visual_socket.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -116,7 +116,7 @@
<p>Slate widget that acts as a socket for the child widget with additional features for <a class="el" href="class_u_visual_image.html" title="Widget that can visualize and animate sprite flipbooks.">UVisualImage</a>.
<a href="#details">More...</a></p>

<p><code>#include &lt;SVisualSocket.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SVisualSocket.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SVisualSocket:</div>
<div class="dyncontent">
Expand Down
2 changes: 1 addition & 1 deletion docs/class_u_background_visual_image-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_u_background_visual_image.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -116,7 +116,7 @@
<p>Visual image that supports transition effects through material.
<a href="#details">More...</a></p>

<p><code>#include &lt;BackgroundVisualImage.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/BackgroundVisualImage.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for UBackgroundVisualImage:</div>
<div class="dyncontent">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_u_info_assignable.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_u_m_e___transition_parameter2_d-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/class_u_m_e___transition_parameter2_d.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
<td id="projectalign">
<div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
<div id="projectname">VisualU<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
</td>
Expand Down Expand Up @@ -117,7 +117,7 @@
<p>Material node for transition materials.
<a href="#details">More...</a></p>

<p><code>#include &lt;ME_TransitionParameter2D.h&gt;</code></p>
<p><code>#include &lt;G:/UE5/UEProjects/5.4/VisualUEx/Plugins/VisualU/Source/VisualU/Public/ME_TransitionParameter2D.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for UME_TransitionParameter2D:</div>
<div class="dyncontent">
Expand Down
Loading

0 comments on commit f7b41ff

Please sign in to comment.