Added basic callback information for v5 for NOTIFY_DEATH_EVENT, NOTIF…

…Y_TOUCH_SIGNPOST and NOTIFY_KILL_ENEMY
RSDKModding · Oct 14, 2024 · dd7b2b1 · dd7b2b1
1 parent dd7b8bd
commit dd7b2b1
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 18 deletions.
diff --git a/docs/Games/SonicOrigins/Documentation/NotifyCallback/DeathEvent.md b/docs/Games/SonicOrigins/Documentation/NotifyCallback/DeathEvent.md
@@ -1,12 +1,24 @@
 # NOTIFY_DEATH_EVENT
 
 ## Description
-Todo.
+Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) of a Player death.
 
 ## Parameters
-`todo`
+=== "v3"
+
+    `todo`
+
+    :    Todo.
+
+=== "v4"
+
+    `todo`
+
+    :    Todo.
+
+=== "v5"
 
-:   Todo.
+    None.
 
 ## Return Value
 None.
@@ -28,7 +40,7 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, int32 todo, NULL, NULL);
+    NotifyCallback(NOTIFY_DEATH_EVENT, NULL, NULL, NULL);
     ```
 
 ## Example
@@ -48,5 +60,5 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, 0, NULL, NULL);
+    NotifyCallback(NOTIFY_DEATH_EVENT, NULL, NULL, NULL);
     ```
diff --git a/docs/Games/SonicOrigins/Documentation/NotifyCallback/KillEnemy.md b/docs/Games/SonicOrigins/Documentation/NotifyCallback/KillEnemy.md
@@ -1,12 +1,30 @@
 # NOTIFY_KILL_ENEMY
 
 ## Description
-Todo.
+Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) to update the mission objective.
 
 ## Parameters
-`todo`
+=== "v3"
+
+    `todo`
+
+    :    Todo.
+
+=== "v4"
+
+    `todo`
+
+    :    Todo.
+
+=== "v5"
+
+    `todo`
+
+    :    Todo.
+
+    `todo2`
 
-:   Todo.
+    :    Todo. Used to add an amount.
 
 ## Return Value
 None.
@@ -28,7 +46,7 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, int32 todo, NULL, NULL);
+    NotifyCallback(NOTIFY_KILL_ENEMY, int32 todo, int32 todo2, NULL);
     ```
 
 ## Example
@@ -48,5 +66,5 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, 0, NULL, NULL);
+    NotifyCallback(NOTIFY_KILL_ENEMY, 0, 0, NULL);
     ```
diff --git a/docs/Games/SonicOrigins/Documentation/NotifyCallback/README.md b/docs/Games/SonicOrigins/Documentation/NotifyCallback/README.md
@@ -24,11 +24,11 @@ NotifyCallback is a function in [Sonic Origins](../../README.md) that handles co
 ## Callbacks
 | ID   | Callback                                               | Description                                                                                                                                               |
 | ---- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 128  | [**NOTIFY_DEATH_EVENT**](DeathEvent.md)                |                                                                                                                                                           |
-| 129  | [**NOTIFY_TOUCH_SIGNPOST**](TouchSignPost.md)          |                                                                                                                                                           |
+| 128  | [**NOTIFY_DEATH_EVENT**](DeathEvent.md)                | Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) of a Player death.                                                                                 |
+| 129  | [**NOTIFY_TOUCH_SIGNPOST**](TouchSignPost.md)          | Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) when a sign post has been touched.                                                                 |
 | 130  | [**NOTIFY_HUD_ENABLE**](HUDEnable.md)                  |                                                                                                                                                           |
 | 131  | [**NOTIFY_ADD_COIN**](AddCoin.md)                      | Awards the player the given amount of coins.                                                                                                              |
-| 132  | [**NOTIFY_KILL_ENEMY**](KillEnemy.md)                  |                                                                                                                                                           |
+| 132  | [**NOTIFY_KILL_ENEMY**](KillEnemy.md)                  | Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) to update the mission objective.                                                                   |
 | 133  | [**NOTIFY_SAVESLOT_SELECT**](SaveSlotSelect.md)        |                                                                                                                                                           |
 | 134  | [**NOTIFY_FUTURE_PAST**](FuturePast.md)                |                                                                                                                                                           |
 | 135  | [**NOTIFY_GOTO_FUTURE_PAST**](GotoFuturePast.md)       |                                                                                                                                                           |

diff --git a/docs/Games/SonicOrigins/Documentation/NotifyCallback/TouchSignPost.md b/docs/Games/SonicOrigins/Documentation/NotifyCallback/TouchSignPost.md
@@ -1,12 +1,24 @@
 # NOTIFY_TOUCH_SIGNPOST
 
 ## Description
-Todo.
+Notifies [Hedgehog Engine 2](../../HedgehogEngine2.md) when a sign post has been touched to signify the completion of the stage in mission mode. In Sonic 3 & Knuckles this is only called from the `SignPost2` object.
 
 ## Parameters
-`todo`
+=== "v3"
+
+    `todo`
+
+    :    Todo.
+
+=== "v4"
+
+    `todo`
+
+    :    Todo.
+
+=== "v5"
 
-:   Todo.
+    None.
 
 ## Return Value
 None.
@@ -28,7 +40,7 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, int32 todo, NULL, NULL);
+    NotifyCallback(NOTIFY_TOUCH_SIGNPOST, NULL, NULL, NULL);
     ```
 
 ## Example
@@ -48,5 +60,5 @@ None.
 === "v5"
 
     ``` c++
-    NotifyCallback(NOTIFY_CALLBACK, 0, NULL, NULL);
+    NotifyCallback(NOTIFY_TOUCH_SIGNPOST, NULL, NULL, NULL);
     ```