Update RSDKv4 Functions

Reformatted function and callback lists to use tables, and fixed many typos, grammatical errors and missing/incorrect info.
RSDKModding · Sep 11, 2024 · 2e05a0c · 2e05a0c
1 parent 4aed845
commit 2e05a0c
Show file tree

Hide file tree

Showing 184 changed files with 919 additions and 886 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <h1>
-    <a href="#hedgedocs">
+    <a href="#rsdk">
         <img width="120" align="left" src="docs/assets/RSDK_Icon_Color.svg">
     </a>
     RSDK<span style="font-weight: 200;"> Modding Wiki</span>

diff --git a/docs/RSDKv4/Functions/3D/Draw3DScene.md b/docs/RSDKv4/Functions/3D/Draw3DScene.md
@@ -9,7 +9,7 @@ None.
 ## Return Value
 None.
 
-## Syntax
+## Example
 ```
 Draw3DScene()
 ```
diff --git a/docs/RSDKv4/Functions/3D/InverseMatrix.md b/docs/RSDKv4/Functions/3D/InverseMatrix.md
diff --git a/docs/RSDKv4/Functions/3D/MatrixInverse.md b/docs/RSDKv4/Functions/3D/MatrixInverse.md
@@ -0,0 +1,24 @@
+# MatrixInverse
+
+!!! note
+    This function does not exist in REV00.
+
+## Description
+Performs an inversion on `matrix`'s values.
+
+## Parameters
+- `matrix`
+The matrix to invert, valid matrices are `MAT_WORLD`, `MAT_VIEW` and `MAT_TEMP`.
+
+## Return Value
+None.
+
+## Syntax
+```
+MatrixInverse(int matrix)
+```
+
+## Example
+```
+MatrixInverse(MAT_WORLD)
+```
diff --git a/docs/RSDKv4/Functions/3D/MatrixMultiply.md b/docs/RSDKv4/Functions/3D/MatrixMultiply.md
@@ -19,7 +19,7 @@ The result will be stored in `matrixA`.
 MatrixMultiply(mat matrixA, mat matrixB)
 ```
 
-## Examples
+## Example
 ```
 MatrixMultiply(mat matrixA, mat matrixB)
 ```
diff --git a/docs/RSDKv4/Functions/3D/MatrixRotateXYZ.md b/docs/RSDKv4/Functions/3D/MatrixRotateXYZ.md
@@ -17,7 +17,7 @@ None.
 MatrixRotateXYZ(mat matrix, int angleX, int angleY, int angleZ)
 ```
 
-## Examples
+## Example
 ```
 MatrixRotateXYZ(MAT_WORLD, 43, 85, 29)
 ```
diff --git a/docs/RSDKv4/Functions/3D/ScaleMatrixXYZ.md → docs/RSDKv4/Functions/3D/MatrixScaleXYZ.md b/docs/RSDKv4/Functions/3D/ScaleMatrixXYZ.md → docs/RSDKv4/Functions/3D/MatrixScaleXYZ.md
@@ -17,7 +17,7 @@ None.
 MatrixScaleXYZ(mat matrix, int scaleX, int scaleY, int scaleZ)
 ```
 
-## Examples
+## Example
 ```
 MatrixScaleXYZ(MAT_VIEW, 0x200, 0x1A0, 0x180)
 ```
diff --git a/docs/RSDKv4/Functions/3D/MatrixTranslateXYZ.md b/docs/RSDKv4/Functions/3D/MatrixTranslateXYZ.md
@@ -17,7 +17,7 @@ None.
 MatrixTranslateXYZ(mat matrix, int translateX, int translateY, int translateZ)
 ```
 
-## Examples
+## Example
 ```
 MatrixTranslateXYZ(MAT_WORLD, -512, 720, temp0)
 ```
diff --git a/docs/RSDKv4/Functions/3D/SetIdentityMatrix.md b/docs/RSDKv4/Functions/3D/SetIdentityMatrix.md
@@ -15,7 +15,7 @@ None.
 SetIdentityMatrix(mat matID)
 ```
 
-## Examples
+## Example
 ```
 SetIdentityMatrix(MAT_WORLD)
 ```
diff --git a/docs/RSDKv4/Functions/3D/TransformVertices.md b/docs/RSDKv4/Functions/3D/TransformVertices.md
@@ -19,7 +19,7 @@ None.
 TransformVertices(mat matrix, int startIndex, int endIndex)
 ```
 
-## Examples
+## Example
 ```
 TransformVertices(MAT_VIEW, 0xFFE, 0x1000)
 ```
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/DrawObjectAnimation.md b/docs/RSDKv4/Functions/Animations-Sprites/DrawObjectAnimation.md
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/DrawSprite.md b/docs/RSDKv4/Functions/Animations-Sprites/DrawSprite.md
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/DrawSpriteFX.md b/docs/RSDKv4/Functions/Animations-Sprites/DrawSpriteFX.md
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/DrawSpriteScreenFX.md b/docs/RSDKv4/Functions/Animations-Sprites/DrawSpriteScreenFX.md
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/EditFrame.md b/docs/RSDKv4/Functions/Animations-Sprites/EditFrame.md
diff --git a/docs/RSDKv4/Functions/Animations-Sprites/ProcessAnimation.md b/docs/RSDKv4/Functions/Animations-Sprites/ProcessAnimation.md
diff --git a/docs/RSDKv4/Functions/Audio/PauseMusic.md b/docs/RSDKv4/Functions/Audio/PauseMusic.md
@@ -1,20 +1,15 @@
 # PauseMusic
 
 ## Description
-Pauses the currently playing music track, if one is playing. The track can be resumed with `ResumeMusic()`.
+Pauses the currently playing music track, if one is playing. The track can be resumed with [ResumeMusic()](ResumeMusic.md).
 
 ## Parameters
 None.
 
 ## Return Value
 None.
 
-## Syntax
-```
-PauseMusic()
-```
-
-## Examples
+## Example
 ```
 PauseMusic()
 ```
diff --git a/docs/RSDKv4/Functions/Audio/PlayMusic.md b/docs/RSDKv4/Functions/Audio/PlayMusic.md
@@ -16,7 +16,7 @@ None.
 PlayMusic(int trackID)
 ```
 
-## Examples
+## Example
 ```
 PlayMusic(0)
 ```
diff --git a/docs/RSDKv4/Functions/Audio/PlaySfx.md b/docs/RSDKv4/Functions/Audio/PlaySfx.md
@@ -18,7 +18,7 @@ None.
 PlaySfx(int sfx, bool loop)
 ```
 
-## Examples
+## Example
 ```
 PlaySfx(SfxName[Test], false)
 ```