Add documentation

This commit is contained in:
Oleg Petruny 2024-09-27 15:25:26 +02:00
parent fc0d3dc52c
commit e3196f462a
7 changed files with 160 additions and 0 deletions

Binary file not shown.

View File

@ -0,0 +1,160 @@
<mxfile host="app.diagrams.net" modified="2024-05-08T09:39:53.079Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36" etag="wAs-_Z6muctMyUQpajhH" version="24.3.1" type="device">
<diagram name="Stránka-1" id="jncRwyBWY97r-PTh6Wm3">
<mxGraphModel dx="2261" dy="746" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="OfQ8P6CXFFix212gcqCM-1" value="ContentLoader" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="340" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-2" value="GameInstance" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="340" y="60" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-3" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-1" target="OfQ8P6CXFFix212gcqCM-2">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="390" y="240" as="sourcePoint" />
<mxPoint x="440" y="190" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-4" value="Appends&amp;nbsp;&lt;span style=&quot;background-color: initial;&quot;&gt;instance.&lt;/span&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;interactionsCollection.&lt;/span&gt;&lt;div&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;(array of interactable interfaces)&lt;/span&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="460" y="5" width="230" height="30" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-5" value="Player" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="340" y="120" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-6" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-2" target="OfQ8P6CXFFix212gcqCM-5">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="410" y="-10" as="sourcePoint" />
<mxPoint x="410" y="70" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-7" value="On instantiation creates InteractableActivator components&lt;div&gt;from `InteractableInterface.GetActivatorsAndCallers()`.&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="460" y="125" width="320" height="30" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-8" value="InteractableActivator" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="40" y="180" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-9" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-5" target="OfQ8P6CXFFix212gcqCM-8">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="410" y="110" as="sourcePoint" />
<mxPoint x="410" y="130" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-10" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-5" target="OfQ8P6CXFFix212gcqCM-8">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="410" y="170" as="sourcePoint" />
<mxPoint x="380" y="200" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-11" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=1;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-5" target="OfQ8P6CXFFix212gcqCM-8">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="420" y="180" as="sourcePoint" />
<mxPoint x="390" y="210" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-12" value="Component with special&amp;nbsp;&lt;div&gt;interactable actor scanning method.&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="-160" y="185" width="200" height="30" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-15" value="Player.&lt;div&gt;InteractableActivated()&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="40" y="120" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-16" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-8" target="OfQ8P6CXFFix212gcqCM-15">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="250" y="170" as="sourcePoint" />
<mxPoint x="220" y="200" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-18" value="MainGameMode&lt;div&gt;.widgetsManager&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="40" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-20" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-15" target="OfQ8P6CXFFix212gcqCM-18">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="190" y="220" as="sourcePoint" />
<mxPoint x="110" y="170" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-21" value="&lt;div&gt;Shows interactions hint.&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="-100" y="5" width="140" height="30" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-22" value="Player.&lt;div&gt;activatedInteractable&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="340" y="240" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-24" value="InteractableCaller" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="620" y="180" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-25" value="" style="endArrow=classic;html=1;rounded=0;entryX=0;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-5" target="OfQ8P6CXFFix212gcqCM-24">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="410" y="170" as="sourcePoint" />
<mxPoint x="330" y="240" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-26" value="" style="endArrow=classic;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=3;" edge="1" parent="1" target="OfQ8P6CXFFix212gcqCM-24">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="400" y="160" as="sourcePoint" />
<mxPoint x="490" y="200" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-27" value="" style="endArrow=classic;html=1;rounded=0;entryX=0;entryY=1;entryDx=0;entryDy=0;strokeWidth=3;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-5" target="OfQ8P6CXFFix212gcqCM-24">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="410" y="170" as="sourcePoint" />
<mxPoint x="490" y="220" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-28" value="Component with special&amp;nbsp;&lt;div&gt;input processing method.&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="740" y="185" width="150" height="30" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-29" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=1;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-15" target="OfQ8P6CXFFix212gcqCM-22">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="270" y="200" as="sourcePoint" />
<mxPoint x="270" y="170" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-32" value="" style="endArrow=classic;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-15" target="OfQ8P6CXFFix212gcqCM-5">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="110" y="200" as="sourcePoint" />
<mxPoint x="110" y="170" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-33" value="Player.&lt;div&gt;EnableInteractableCallers&lt;/div&gt;&lt;div&gt;ByInteractableImplemented&lt;/div&gt;&lt;div&gt;InteractionInterfaces&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="170" y="60" width="150" height="70" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-34" value="InputEvents" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="620" y="240" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-35" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.25;entryY=0;entryDx=0;entryDy=0;exitX=0.25;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-24" target="OfQ8P6CXFFix212gcqCM-34">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="550" y="110" as="sourcePoint" />
<mxPoint x="550" y="130" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-36" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-24" target="OfQ8P6CXFFix212gcqCM-34">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="660" y="230" as="sourcePoint" />
<mxPoint x="660" y="250" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-37" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.75;entryY=0;entryDx=0;entryDy=0;exitX=0.75;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-24" target="OfQ8P6CXFFix212gcqCM-34">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="690" y="230" as="sourcePoint" />
<mxPoint x="690" y="250" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-38" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=0;entryDx=0;entryDy=0;exitX=0;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-34" target="OfQ8P6CXFFix212gcqCM-22">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="520" y="230" as="sourcePoint" />
<mxPoint x="520" y="250" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-40" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=1;entryDx=0;entryDy=0;exitX=0;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="OfQ8P6CXFFix212gcqCM-34" target="OfQ8P6CXFFix212gcqCM-22">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="490" y="270" as="sourcePoint" />
<mxPoint x="470" y="270" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="OfQ8P6CXFFix212gcqCM-41" value="&lt;div&gt;Interactable&lt;/div&gt;.Call(InputDescription)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="460" y="245" width="160" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
Documentation/Story.docx Normal file

Binary file not shown.

Binary file not shown.