Merge pull request #83 from oceanstuck/master

Q2 library documentation
tge-was-taken · Nov 25, 2024 · 60c49e9 · 60c49e9
2 parents 48194b4 + 7dd4684
commit 60c49e9
Show file tree

Hide file tree

Showing 11 changed files with 1,021 additions and 421 deletions.
diff --git a/Source/AtlusScriptLibrary/AtlusScriptLibrary.csproj b/Source/AtlusScriptLibrary/AtlusScriptLibrary.csproj
diff --git a/Source/AtlusScriptLibrary/Libraries/Persona5Royal/MessageScriptLibrary.json b/Source/AtlusScriptLibrary/Libraries/Persona5Royal/MessageScriptLibrary.json
@@ -594,10 +594,32 @@
         "Name": "selTex",
         "Description": "overrides game logic deciding which dialogue select portrait to display",
         "Parameters": [
-			{
+          {
             "Name": "selMajorId",
             "Description": "the major id of the select portrait to display (FONT/SELECT/CUTIN_XXX_000.DDS)"
-			}
+          }
+        ]
+      },
+      {
+        "Index": 30,
+        "Name": "",
+        "Description": "",
+        "Parameters": [
+        ]
+      },
+      {
+        "Index": 31,
+        "Name": "sumi",
+        "Description": "Yoshizawa name check.",
+        "Parameters": [
+          {
+            "Name": "partyID",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          }
         ]
       }
     ]

diff --git a/Source/AtlusScriptLibrary/Libraries/PersonaQ2/FlowScriptModules.json b/Source/AtlusScriptLibrary/Libraries/PersonaQ2/FlowScriptModules.json
@@ -12,7 +12,7 @@
     "ShortName": "wnd",
     "Description": "",
     "ConstantsPath": "",
-    "EnumsPath": "",
+    "EnumsPath": "PersonaQ2\\Modules\\Window\\Enums.json",
     "FunctionsPath": "PersonaQ2\\Modules\\Window\\Functions.json"
   },
   {
@@ -44,7 +44,7 @@
     "ShortName": "scr",
     "Description": "",
     "ConstantsPath": "",
-    "EnumsPath": "",
+    "EnumsPath": "PersonaQ2\\Modules\\Script\\Enums.json",
     "FunctionsPath": "PersonaQ2\\Modules\\Script\\Functions.json"
   },
   {

diff --git a/Source/AtlusScriptLibrary/Libraries/PersonaQ2/MessageScriptLibrary.json b/Source/AtlusScriptLibrary/Libraries/PersonaQ2/MessageScriptLibrary.json
@@ -1,3 +1,188 @@
 [
-
+  {
+    "Index": 0,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 0,
+        "Name": "clr",
+        "Description": "",
+        "Parameters": [
+          {
+            "Name": "color"
+          }
+        ]
+      },
+      {
+        "Index": 5,
+        "Semantic": "Unused"
+      }
+    ]
+  },
+  {
+    "Index": 1,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 1,
+        "Name": "w",
+        "Description": "Waits for button press.",
+        "Parameters": []
+      },
+      {
+        "Index": 3,
+        "Description": "",
+        "Parameters": [
+          {
+            "Name": "unknown"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "Index": 2,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 1,
+        "Name": "s",
+        "Description": "Indicates the start of a line",
+        "Parameters": [
+        ]
+      },
+      {
+        "Index": 7,
+        "Name": "unknown",
+        "Description": "",
+        "Parameters": [
+          {
+            "Name": "unknown",
+            "Description": ""
+          },
+          {
+            "Name": "modelID",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "Index": 3,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 1,
+        "Name": "vp",
+        "Description": "Plays a voice sound cue.",
+        "Parameters": [
+          {
+            "Name": "unknown",
+            "Description": "unknown"
+          },
+          {
+            "Name": "unknown",
+            "Description": "unknown"
+          },
+          {
+            "Name": "unknown",
+            "Description": "unknown"
+          },
+          {
+            "Name": "cueID",
+            "Description": "Cue ID of the voiceline."
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "Index": 4,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 6,
+        "Name": "bup",
+        "Description": "Displays a bustup.",
+        "Parameters": [
+          {
+            "Name": "modelID",
+            "Description": ""
+          },
+          {
+            "Name": "animID",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          },
+          {
+            "Name": "location",
+            "Description": "Determines model's location on screen."
+          }
+        ]
+      },
+      {
+        "Index": 7,
+        "Name": "",
+        "Description": "",
+        "Parameters": [
+          {
+            "Name": "unknown1"
+          },
+          {
+            "Name": "unknown2"
+          },
+          {
+            "Name": "unknown3"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "Index": 6,
+    "Name": "",
+    "Description": "",
+    "Functions": [
+      {
+        "Index": 1,
+        "Name": "name",
+        "Description": "Displays a protagonist name.",
+        "Parameters": [
+          {
+            "Name": "id",
+            "Description": "Designates which PC name to call and whether to call first, last, or full name."
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          },
+          {
+            "Name": "unknown",
+            "Description": ""
+          }
+        ]
+      }
+    ]
+  }
 ]
diff --git a/Source/AtlusScriptLibrary/Libraries/PersonaQ2/Modules/Battle/Functions.json b/Source/AtlusScriptLibrary/Libraries/PersonaQ2/Modules/Battle/Functions.json
@@ -1923,14 +1923,17 @@
   {
     "Index": "0x309d",
     "ReturnType": "int",
-    "Name": "BTL_FUNCTION_009D",
-    "Description": "",
+    "Name": "GET_ENEMY_ID",
+    "Description": "Get ID of enemy in a given formation slot.",
     "Parameters": [
       {
         "Type": "int",
-        "Name": "param1",
+        "Name": "fSlot",
         "Description": ""
       }
+    ],
+    "Aliases": [
+      "BTL_FUNCTION_009D"
     ]
   },
   {
@@ -5033,21 +5036,28 @@
   {
     "Index": "0x3157",
     "ReturnType": "int",
-    "Name": "BTL_FUNCTION_0157",
+    "Name": "GET_ENCOUNT_ID",
     "Description": "",
-    "Parameters": []
+    "Parameters": [
+    ],
+    "Aliases": [
+      "BTL_FUNCTION_0157"
+    ]
   },
   {
     "Index": "0x3158",
     "ReturnType": "void",
-    "Name": "BTL_FUNCTION_0158",
+    "Name": "PLAY_BATTLE_BGM",
     "Description": "",
     "Parameters": [
       {
         "Type": "int",
-        "Name": "param1",
+        "Name": "cueID",
         "Description": ""
       }
+    ],
+    "Aliases": [
+      "BTL_FUNCTION_0158"
     ]
   },
   {
@@ -6293,5 +6303,43 @@
         "Description": ""
       }
     ]
+  },
+  {
+    "Index": "0x31a3",
+    "ReturnType": "void",
+    "Name": "MSG_UNISON",
+    "Description": "Displays a message as a subtitle during a Unison Skill.",
+    "Parameters": [
+      {
+        "Type": "int",
+        "Name": "msgID",
+        "Description": "",
+        "Semantic": "MsgId"
+      },
+      {
+        "Type": "int",
+        "Name": "frame",
+        "Description": "Time (in frames?) at which message appears."
+      }
+    ],
+    "Aliases": [
+      "BTL_FUNCTION_01A3"
+    ]
+  },
+  {
+    "Index": "0x31a4",
+    "ReturnType": "void",
+    "Name": "MSG_UNISON_SET_DURATION",
+    "Description": "Sets length of time for which messages during Unison Skills are displayed.",
+    "Parameters": [
+      {
+        "Type": "int",
+        "Name": "duration",
+        "Description": ""
+      }
+    ],
+    "Aliases": [
+      "BTL_FUNCTION_01A4"
+    ]
   }
 ]