Merge pull request #1 from ecell/documentation

Documentation
ecell · Oct 20, 2023 · 70ffa11 · 70ffa11
2 parents 276aea1 + b6ed23a
commit 70ffa11
Show file tree

Hide file tree

Showing 388 changed files with 16,418 additions and 111,053 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -19,6 +19,15 @@ jobs:
         #run: choco install -y docfx
         run: dotnet tool install -g docfx
 
+      - name: plantuml
+        id: plantuml
+        uses: grassedge/[email protected]
+        with:
+          path: .
+          message: "Render PlantUML files"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build
         run: docfx DocFX/docfx.json
 

diff --git a/.gitignore b/.gitignore
@@ -68,3 +68,6 @@ UserSettings/
 
 #Sattelite packages unrelated to the Unity e.g. DocFx app
 Packages/docfx.*
+
+#Docfx build directory
+docs/
diff --git a/Assets/Resources/Prefabs/Modules/BaseGameNetModule.prefab b/Assets/Resources/Prefabs/Modules/BaseGameNetModule.prefab
@@ -112,7 +112,7 @@ MonoBehaviour:
   m_OnCullStateChanged:
     m_PersistentCalls:
       m_Calls: []
-  m_text: Base Module
+  m_text: Base Game Net Module
   m_isRightToLeft: 0
   m_fontAsset: {fileID: 11400000, guid: 8f586378b4e144a9851e7b34d9b748ee, type: 2}
   m_sharedMaterial: {fileID: 2180264, guid: 8f586378b4e144a9851e7b34d9b748ee, type: 2}
@@ -214,8 +214,8 @@ RectTransform:
   m_LocalScale: {x: 0.01, y: 0.01, z: 1}
   m_Children:
   - {fileID: 5490768552337110263}
-  m_Father: {fileID: 5808524772636809829}
-  m_RootOrder: 0
+  m_Father: {fileID: 3736753909790639511}
+  m_RootOrder: 1
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
   m_AnchorMin: {x: 0, y: 0}
   m_AnchorMax: {x: 0, y: 0}
@@ -335,7 +335,8 @@ GameObject:
   - component: {fileID: 2994018189313980719}
   - component: {fileID: 3735617305922302978}
   - component: {fileID: 9205149490526423619}
-  - component: {fileID: 5016764923900078323}
+  - component: {fileID: 9047515274596518738}
+  - component: {fileID: 611334380818735798}
   - component: {fileID: 5118464661425326381}
   m_Layer: 7
   m_Name: BaseGameNetModule
@@ -356,7 +357,7 @@ Transform:
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_Children:
   - {fileID: 7648479246611462464}
-  - {fileID: 5808524772636809829}
+  - {fileID: 7367517930132838063}
   - {fileID: 6851848954270253065}
   - {fileID: 4233068806344191310}
   m_Father: {fileID: 0}
@@ -400,7 +401,7 @@ MonoBehaviour:
   m_FirstHoverEntered:
     m_PersistentCalls:
       m_Calls:
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
         m_MethodName: ShowName
         m_Mode: 1
@@ -412,7 +413,7 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 1
         m_CallState: 2
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
         m_MethodName: SetFocus
         m_Mode: 1
@@ -424,21 +425,9 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 1
         m_CallState: 2
-      - m_Target: {fileID: 5016764923900078323}
-        m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
-        m_MethodName: SetHighlightServerRpc
-        m_Mode: 1
-        m_Arguments:
-          m_ObjectArgument: {fileID: 0}
-          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
-          m_IntArgument: 0
-          m_FloatArgument: 0
-          m_StringArgument: 
-          m_BoolArgument: 1
-        m_CallState: 2
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
-        m_MethodName: ShowInfoTags
+        m_MethodName: SetHighlight
         m_Mode: 1
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -451,7 +440,7 @@ MonoBehaviour:
   m_LastHoverExited:
     m_PersistentCalls:
       m_Calls:
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
         m_MethodName: UnsetFocus
         m_Mode: 1
@@ -463,9 +452,9 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
-        m_MethodName: UnsetHighlightServerRpc
+        m_MethodName: UnsetHighlight
         m_Mode: 1
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -599,9 +588,9 @@ MonoBehaviour:
   m_OnPostGrabMovementUpdate:
     m_PersistentCalls:
       m_Calls:
-      - m_Target: {fileID: 5016764923900078323}
-        m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
-        m_MethodName: ShowName
+      - m_Target: {fileID: 9047515274596518738}
+        m_TargetAssemblyTypeName: ECellDive.Utility.FaceCamera, Assembly-CSharp
+        m_MethodName: LookAt
         m_Mode: 1
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -611,9 +600,9 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
-      - m_Target: {fileID: 5016764923900078323}
+      - m_Target: {fileID: 611334380818735798}
         m_TargetAssemblyTypeName: ECellDive.Modules.GameNetModule, Assembly-CSharp
-        m_MethodName: ShowInfoTags
+        m_MethodName: ShowName
         m_Mode: 1
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -682,7 +671,23 @@ MonoBehaviour:
     m_PreInfinity: 2
     m_PostInfinity: 2
     m_RotationOrder: 4
---- !u!114 &5016764923900078323
+--- !u!114 &9047515274596518738
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 3736753909790639510}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 2dc6fa794660ef24784ded0358f6755d, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  showOnEnable: 1
+  m_flip: 0
+  m_popupDistance: 0
+  m_popupHeightOffset: 0
+--- !u!114 &611334380818735798
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -691,12 +696,13 @@ MonoBehaviour:
   m_GameObject: {fileID: 3736753909790639510}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 24670cf497b8807418da78d0d4133f1d, type: 3}
+  m_Script: {fileID: 11500000, guid: bd30c3ae9df687a40ba6a29b24c5dce6, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
   m_Collider: {fileID: 6913024637130908595}
   m_Renderer: {fileID: 2183908856584122}
   m_LineRenderer: {fileID: 0}
+  m_delegateTarget: {fileID: 0}
   m_currentColor:
     m_InternalValue: {r: 0, g: 0, b: 0, a: 0}
   m_defaultColor: {r: 1, g: 1, b: 1, a: 0}
@@ -706,7 +712,7 @@ MonoBehaviour:
     m_right: {fileID: -7671817019672214048, guid: 20c9f019e259ffd43bcace5674974990, type: 3}
   m_refInfoTagPrefab: {fileID: 4233068806344191311}
   m_refInfoTagsContainer: {fileID: 1083596140267232881}
-  m_nameTextFieldContainer: {fileID: 7238008436644870242}
+  m_nameTextFieldContainer: {fileID: 3091464255799882709}
 --- !u!114 &5118464661425326381
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -736,7 +742,7 @@ GameObject:
   - component: {fileID: 7874839602160917557}
   - component: {fileID: 2183908856584122}
   m_Layer: 7
-  m_Name: Graphics
+  m_Name: Module Graphics
   m_TagString: Untagged
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
@@ -818,54 +824,6 @@ MeshRenderer:
   m_SortingLayer: 0
   m_SortingOrder: 0
   m_AdditionalVertexStreams: {fileID: 0}
---- !u!1 &7238008436644870242
-GameObject:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  serializedVersion: 6
-  m_Component:
-  - component: {fileID: 5808524772636809829}
-  - component: {fileID: 2366562821304158062}
-  m_Layer: 7
-  m_Name: NameContainer
-  m_TagString: Untagged
-  m_Icon: {fileID: 0}
-  m_NavMeshLayer: 0
-  m_StaticEditorFlags: 0
-  m_IsActive: 1
---- !u!4 &5808524772636809829
-Transform:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 7238008436644870242}
-  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 0, z: 0}
-  m_LocalScale: {x: 1, y: 1, z: 1}
-  m_Children:
-  - {fileID: 7367517930132838063}
-  m_Father: {fileID: 3736753909790639511}
-  m_RootOrder: 1
-  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
---- !u!114 &2366562821304158062
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 7238008436644870242}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 2dc6fa794660ef24784ded0358f6755d, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
-  showOnEnable: 1
-  m_flip: 1
-  m_popupDistance: 0
-  m_popupHeightOffset: 0
 --- !u!1001 &3936853800347572759
 PrefabInstance:
   m_ObjectHideFlags: 0

diff --git a/Assets/Resources/Prefabs/Modules/BaseModule.prefab b/Assets/Resources/Prefabs/Modules/BaseModule.prefab
@@ -162,7 +162,7 @@ Transform:
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_Children: []
   m_Father: {fileID: 2682144873032837814}
-  m_RootOrder: 0
+  m_RootOrder: 2
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!1 &2682144873032837815
 GameObject:
@@ -196,10 +196,10 @@ Transform:
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_Children:
-  - {fileID: 5329395802218917672}
-  - {fileID: 3196879304267973231}
   - {fileID: 5486488718019400936}
   - {fileID: 8132893898276993422}
+  - {fileID: 5329395802218917672}
+  - {fileID: 3196879304267973231}
   m_Father: {fileID: 0}
   m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
@@ -265,6 +265,18 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 1
         m_CallState: 2
+      - m_Target: {fileID: 9103329625996699262}
+        m_TargetAssemblyTypeName: ECellDive.Modules.Module, Assembly-CSharp
+        m_MethodName: SetHighlight
+        m_Mode: 1
+        m_Arguments:
+          m_ObjectArgument: {fileID: 0}
+          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
+          m_IntArgument: 0
+          m_FloatArgument: 0
+          m_StringArgument: 
+          m_BoolArgument: 1
+        m_CallState: 2
   m_LastHoverExited:
     m_PersistentCalls:
       m_Calls:
@@ -280,6 +292,18 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
+      - m_Target: {fileID: 9103329625996699262}
+        m_TargetAssemblyTypeName: ECellDive.Modules.Module, Assembly-CSharp
+        m_MethodName: UnsetHighlight
+        m_Mode: 1
+        m_Arguments:
+          m_ObjectArgument: {fileID: 0}
+          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
+          m_IntArgument: 0
+          m_FloatArgument: 0
+          m_StringArgument: 
+          m_BoolArgument: 0
+        m_CallState: 2
   m_HoverEntered:
     m_PersistentCalls:
       m_Calls: []
@@ -404,9 +428,9 @@ MonoBehaviour:
   m_OnPostGrabMovementUpdate:
     m_PersistentCalls:
       m_Calls:
-      - m_Target: {fileID: 9103329625996699262}
-        m_TargetAssemblyTypeName: ECellDive.Modules.Module, Assembly-CSharp
-        m_MethodName: ShowNameToPlayer
+      - m_Target: {fileID: 8232725348062569359}
+        m_TargetAssemblyTypeName: ECellDive.Utility.FaceCamera, Assembly-CSharp
+        m_MethodName: LookAt
         m_Mode: 1
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -525,6 +549,7 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   refName: {fileID: 4416525400321850023}
+  m_delegateTarget: {fileID: 0}
   m_defaultColor: {r: 0.78431374, g: 0.78431374, b: 0.78431374, a: 1}
   m_highlightColor: {r: 0, g: 0.8980392, b: 0.8962264, a: 1}
   m_displayInfoTagsActions:
@@ -564,7 +589,7 @@ Transform:
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_Children: []
   m_Father: {fileID: 2682144873032837814}
-  m_RootOrder: 2
+  m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!65 &40732776446777649
 BoxCollider:
@@ -577,7 +602,7 @@ BoxCollider:
   m_IsTrigger: 0
   m_Enabled: 1
   serializedVersion: 2
-  m_Size: {x: 1, y: 1, z: 1}
+  m_Size: {x: 1.5, y: 2, z: 0.1}
   m_Center: {x: 0, y: 0, z: 0}
 --- !u!33 &5683426884275743703
 MeshFilter:
@@ -586,7 +611,7 @@ MeshFilter:
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 2737847575246320643}
-  m_Mesh: {fileID: 10202, guid: 0000000000000000e000000000000000, type: 0}
+  m_Mesh: {fileID: -2502713704228943738, guid: 27d13545e0bb9af47bf732766354b555, type: 3}
 --- !u!23 &8339200916974242502
 MeshRenderer:
   m_ObjectHideFlags: 0
@@ -662,11 +687,11 @@ RectTransform:
   m_Children:
   - {fileID: 6543828685910055894}
   m_Father: {fileID: 2682144873032837814}
-  m_RootOrder: 3
+  m_RootOrder: 1
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
   m_AnchorMin: {x: 0, y: 0}
   m_AnchorMax: {x: 0, y: 0}
-  m_AnchoredPosition: {x: 0, y: 0.75}
+  m_AnchoredPosition: {x: 0, y: 1.15}
   m_SizeDelta: {x: 0, y: 0}
   m_Pivot: {x: 0.5, y: 0.5}
 --- !u!223 &387142468034050405
@@ -783,7 +808,7 @@ PrefabInstance:
       objectReference: {fileID: 0}
     - target: {fileID: 872680225068267353, guid: b0516a8b5fdc4b14d9ebd85965bc6eaa, type: 3}
       propertyPath: m_RootOrder
-      value: 1
+      value: 3
       objectReference: {fileID: 0}
     - target: {fileID: 872680225068267353, guid: b0516a8b5fdc4b14d9ebd85965bc6eaa, type: 3}
       propertyPath: m_LocalPosition.x