Add RSDK version page tags

RSDKModding · Feb 5, 2025 · 0d1921c · 0d1921c
1 parent ec5c654
commit 0d1921c
Show file tree

Hide file tree

Showing 174 changed files with 189 additions and 165 deletions.
diff --git a/docs/Guides/RSDKv3/.meta.yml b/docs/Guides/RSDKv3/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv3
diff --git a/docs/Guides/RSDKv4/.meta.yml b/docs/Guides/RSDKv4/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv4
diff --git a/docs/Guides/RSDKv5/.meta.yml b/docs/Guides/RSDKv5/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv5
diff --git a/docs/RSDKv1/.meta.yml b/docs/RSDKv1/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv1
diff --git a/docs/RSDKv2/.meta.yml b/docs/RSDKv2/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv2
diff --git a/docs/RSDKv3/.meta.yml b/docs/RSDKv3/.meta.yml
@@ -0,0 +1,2 @@
+tags:
+    - RSDKv3
diff --git a/docs/RSDKv3/Functions/3D/Draw3DScene.md b/docs/RSDKv3/Functions/3D/Draw3DScene.md
@@ -1,4 +1,4 @@
-# Draw3DScene <small>(RSDKv3)</small>
+# Draw3DScene
 
 ## Description
 Draws the active 3DScene data to the screen.

diff --git a/docs/RSDKv3/Functions/3D/MatrixMultiply.md b/docs/RSDKv3/Functions/3D/MatrixMultiply.md
@@ -1,4 +1,4 @@
-# MatrixMultiply <small>(RSDKv3)</small>
+# MatrixMultiply
 
 ## Description
 Multiplies `MatrixA` by `MatrixB`.

diff --git a/docs/RSDKv3/Functions/3D/MatrixRotate.md b/docs/RSDKv3/Functions/3D/MatrixRotate.md
@@ -1,4 +1,4 @@
-# MatrixRotate X/Y/Z <small>(RSDKv3)</small>
+# MatrixRotate X/Y/Z
 
 ## Description
 Rotates `Matrix` to `Angle` on the specified axis.

diff --git a/docs/RSDKv3/Functions/3D/MatrixRotateXYZ.md b/docs/RSDKv3/Functions/3D/MatrixRotateXYZ.md
@@ -1,4 +1,4 @@
-# MatrixRotateXYZ <small>(RSDKv3)</small>
+# MatrixRotateXYZ
 
 ## Description
 Rotates `Matrix` to `AngleX`, `AngleY` and `AngleZ`.

diff --git a/docs/RSDKv3/Functions/3D/MatrixScaleXYZ.md b/docs/RSDKv3/Functions/3D/MatrixScaleXYZ.md
@@ -1,4 +1,4 @@
-# MatrixScaleXYZ <small>(RSDKv3)</small>
+# MatrixScaleXYZ
 
 ## Description
 Scales `Matrix` to `ScaleX`, `ScaleY` and `ScaleZ`.

diff --git a/docs/RSDKv3/Functions/3D/MatrixTranslateXYZ.md b/docs/RSDKv3/Functions/3D/MatrixTranslateXYZ.md
@@ -1,4 +1,4 @@
-# MatrixTranslateXYZ <small>(RSDKv3)</small>
+# MatrixTranslateXYZ
 
 ## Description
 Translates `Matrix` to `TranslateX`, `TranslateY` and `TranslateZ`.

diff --git a/docs/RSDKv3/Functions/3D/SetIdentityMatrix.md b/docs/RSDKv3/Functions/3D/SetIdentityMatrix.md
@@ -1,4 +1,4 @@
-# SetIdentityMatrix <small>(RSDKv3)</small>
+# SetIdentityMatrix
 
 ## Description
 Sets the matrix of `MatID` to the identity state.

diff --git a/docs/RSDKv3/Functions/3D/TransformVertices.md b/docs/RSDKv3/Functions/3D/TransformVertices.md
@@ -1,4 +1,4 @@
-# TransformVertices <small>(RSDKv3)</small>
+# TransformVertices
 
 ## Description
 Transform all vertices from `StartIndex` to `EndIndex` using `Matrix`.

diff --git a/docs/RSDKv3/Functions/Audio/PauseMusic.md b/docs/RSDKv3/Functions/Audio/PauseMusic.md
@@ -1,4 +1,4 @@
-# PauseMusic <small>(RSDKv3)</small>
+# PauseMusic
 
 ## Description
 Pauses the currently playing music track, if one is playing. The track can be resumed with [ResumeMusic()](ResumeMusic.md).

diff --git a/docs/RSDKv3/Functions/Audio/PlayMusic.md b/docs/RSDKv3/Functions/Audio/PlayMusic.md
@@ -1,4 +1,4 @@
-# PlayMusic <small>(RSDKv3)</small>
+# PlayMusic
 
 ## Description
 Plays the music currently loaded in the given track slot.

diff --git a/docs/RSDKv3/Functions/Audio/PlaySfx.md b/docs/RSDKv3/Functions/Audio/PlaySfx.md
@@ -1,4 +1,4 @@
-# PlaySfx <small>(RSDKv3)</small>
+# PlaySfx
 
 ## Description
 Plays the sound effect in the given slot in the GameConfig, looping it if set to do so.

diff --git a/docs/RSDKv3/Functions/Audio/ResumeMusic.md b/docs/RSDKv3/Functions/Audio/ResumeMusic.md
@@ -1,4 +1,4 @@
-# ResumeMusic <small>(RSDKv3)</small>
+# ResumeMusic
 
 ## Description
 If a track has been paused with [PauseMusic()](PauseMusic.md), resumes playing the track.

diff --git a/docs/RSDKv3/Functions/Audio/SetMusicTrack.md b/docs/RSDKv3/Functions/Audio/SetMusicTrack.md
@@ -1,4 +1,4 @@
-# SetMusicTrack <small>(RSDKv3)</small>
+# SetMusicTrack
 
 ## Description
 Loads a music file in the given track slot with the given loop point.

diff --git a/docs/RSDKv3/Functions/Audio/SetSfxAttributes.md b/docs/RSDKv3/Functions/Audio/SetSfxAttributes.md
@@ -1,4 +1,4 @@
-# SetSfxAttributes <small>(RSDKv3)</small>
+# SetSfxAttributes
 
 ## Description
 Sets the loop count and panning of the given sound effect slot in the GameConfig to the given values.

diff --git a/docs/RSDKv3/Functions/Audio/StopMusic.md b/docs/RSDKv3/Functions/Audio/StopMusic.md
@@ -1,4 +1,4 @@
-# StopMusic <small>(RSDKv3)</small>
+# StopMusic
 
 ## Description
 Stops playing the currently playing music track, if one is playing.

diff --git a/docs/RSDKv3/Functions/Audio/StopSfx.md b/docs/RSDKv3/Functions/Audio/StopSfx.md
@@ -1,4 +1,4 @@
-# StopSfx <small>(RSDKv3)</small>
+# StopSfx
 
 ## Description
 Stops all instances of the given sound effect slot in the GameConfig playing.

diff --git a/docs/RSDKv3/Functions/Drawing/AddDrawListEntityRef.md b/docs/RSDKv3/Functions/Drawing/AddDrawListEntityRef.md
@@ -1,4 +1,4 @@
-# AddDrawListEntityRef <small>(RSDKv3)</small>
+# AddDrawListEntityRef
 
 ## Description
 Adds `ObjectPos` to drawList `Layer`.

diff --git a/docs/RSDKv3/Functions/Drawing/ClearDrawList.md b/docs/RSDKv3/Functions/Drawing/ClearDrawList.md
@@ -1,4 +1,4 @@
-# ClearDrawList <small>(RSDKv3)</small>
+# ClearDrawList
 
 ## Description
 Removes all entries in drawList `Layer`.

diff --git a/docs/RSDKv3/Functions/Drawing/ClearScreen.md b/docs/RSDKv3/Functions/Drawing/ClearScreen.md
@@ -1,4 +1,4 @@
-# ClearScreen <small>(RSDKv3)</small>
+# ClearScreen
 
 ## Description
 Clears all pixels on screen with color `ClearIndex` from the active palette.

diff --git a/docs/RSDKv3/Functions/Drawing/CopyPalette.md b/docs/RSDKv3/Functions/Drawing/CopyPalette.md
@@ -1,4 +1,4 @@
-# CopyPalette <small>(RSDKv3)</small>
+# CopyPalette
 
 ## Description
 Copies `SrcPal` into `DstPal`.

diff --git a/docs/RSDKv3/Functions/Drawing/DrawRect.md b/docs/RSDKv3/Functions/Drawing/DrawRect.md
@@ -1,4 +1,4 @@
-# DrawRect <small>(RSDKv3)</small>
+# DrawRect
 
 ## Description
 Draws a rectangle to `iXPos` and `iYPos` in screen-space, with a color based on the `R`, `G`, `B`, and `Alpha`.

diff --git a/docs/RSDKv3/Functions/Drawing/DrawTintRect.md b/docs/RSDKv3/Functions/Drawing/DrawTintRect.md
@@ -1,4 +1,4 @@
-# DrawTintRect <small>(RSDKv3)</small>
+# DrawTintRect
 
 ## Description
 Draws a tinted rectangle to `iXPos` and `iYPos` in screen-space.

diff --git a/docs/RSDKv3/Functions/Drawing/GetDrawListEntityRef.md b/docs/RSDKv3/Functions/Drawing/GetDrawListEntityRef.md
@@ -1,4 +1,4 @@
-# GetDrawListEntityRef <small>(RSDKv3)</small>
+# GetDrawListEntityRef
 
 ## Description
 Gets `ObjectPos` in drawList `Layer` and stores it in `Store`.

diff --git a/docs/RSDKv3/Functions/Drawing/LoadPalette.md b/docs/RSDKv3/Functions/Drawing/LoadPalette.md
@@ -1,4 +1,4 @@
-# LoadPalette <small>(RSDKv3)</small>
+# LoadPalette
 
 ## Description
 Loads a palette into `PalBank` starting from `StartPalIndex`, with an offset of `StartIndex` and reading all colors through to `EndIndex`.

diff --git a/docs/RSDKv3/Functions/Drawing/RotatePalette.md b/docs/RSDKv3/Functions/Drawing/RotatePalette.md
@@ -1,4 +1,4 @@
-# RotatePalette <small>(RSDKv3)</small>
+# RotatePalette
 
 ## Description
 Rotates all colors in the active palette bank from `StartIndex` to `EndIndex`, moving left or right depending on `RotRight`.

diff --git a/docs/RSDKv3/Functions/Drawing/SetActivePalette.md b/docs/RSDKv3/Functions/Drawing/SetActivePalette.md
@@ -1,4 +1,4 @@
-# SetActivePalette <small>(RSDKv3)</small>
+# SetActivePalette
 
 ## Description
 Sets the active palette to `PalBank` for all vertical screen lines from `StartLine` to `EndLine`.

diff --git a/docs/RSDKv3/Functions/Drawing/SetDrawListEntityRef.md b/docs/RSDKv3/Functions/Drawing/SetDrawListEntityRef.md
@@ -1,4 +1,4 @@
-## SetDrawListEntityRef <small>(RSDKv3)</small>
+## SetDrawListEntityRef
 
 ## Description
 Sets `ObjectPos` in drawList `Layer` to `Value`.

diff --git a/docs/RSDKv3/Functions/Drawing/SetPaletteFade.md b/docs/RSDKv3/Functions/Drawing/SetPaletteFade.md
@@ -1,4 +1,4 @@
-# SetPaletteFade <small>(RSDKv3)</small>
+# SetPaletteFade
 
 ## Description
 Blends the currectly active palette from `StartIndex` to `EndIndex` based on `R`, `G`, `B`, and `BlendAmount`, and stores the new palette in `DstBank`.

diff --git a/docs/RSDKv3/Functions/Drawing/SetScreenFade.md b/docs/RSDKv3/Functions/Drawing/SetScreenFade.md
@@ -1,4 +1,4 @@
-# SetScreenFade <small>(RSDKv3)</small>
+# SetScreenFade
 
 ## Description
 Adds a screen fade effect based on the `R`, `G`, `B` and `Alpha` values.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawObjectAnimation.md b/docs/RSDKv3/Functions/Graphics/DrawObjectAnimation.md
@@ -1,4 +1,4 @@
-# DrawObjectAnimation <small>(RSDKv3)</small>
+# DrawObjectAnimation
 
 ## Description
 Draws an object's sprites from the animation file loaded prior via [LoadAnimation()](LoadAnimation.md). The sprite will be drawn at `object.xpos` and `object.ypos`, with flipping and rotation applied based on the current animation's rotate style.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawSprite.md b/docs/RSDKv3/Functions/Graphics/DrawSprite.md
@@ -1,4 +1,4 @@
-# DrawSprite <small>(RSDKv3)</small>
+# DrawSprite
 
 ## Description
 Draws `Frame` at the object's X and Y position.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawSpriteFX.md b/docs/RSDKv3/Functions/Graphics/DrawSpriteFX.md
@@ -1,4 +1,4 @@
-# DrawSpriteFX <small>(RSDKv3)</small>
+# DrawSpriteFX
 
 ## Description
 Draws `Frame` at a specified X and Y position with visual effects.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawSpriteScreenFX.md b/docs/RSDKv3/Functions/Graphics/DrawSpriteScreenFX.md
@@ -1,4 +1,4 @@
-# DrawSpriteScreenFX <small>(RSDKv3)</small>
+# DrawSpriteScreenFX
 
 ## Description
 Draws `Frame` at a specified X and Y position in screen-space with visual effects.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawSpriteScreenXY.md b/docs/RSDKv3/Functions/Graphics/DrawSpriteScreenXY.md
@@ -1,4 +1,4 @@
-# DrawSpriteScreenXY <small>(RSDKv3)</small>
+# DrawSpriteScreenXY
 
 ## Description
 Draws `Frame` at a specified X and Y position in screen-space.

diff --git a/docs/RSDKv3/Functions/Graphics/DrawSpriteXY.md b/docs/RSDKv3/Functions/Graphics/DrawSpriteXY.md
@@ -1,4 +1,4 @@
-# DrawSpriteXY <small>(RSDKv3)</small>
+# DrawSpriteXY
 
 ## Description
 Draws `Frame` at a specified X and Y position.

diff --git a/docs/RSDKv3/Functions/Graphics/EditFrame.md b/docs/RSDKv3/Functions/Graphics/EditFrame.md
@@ -1,4 +1,4 @@
-# EditFrame <small>(RSDKv3)</small>
+# EditFrame
 
 !!! note
     This function does not exist in the Blit releases of Sonic CD.

diff --git a/docs/RSDKv3/Functions/Graphics/LoadAnimation.md b/docs/RSDKv3/Functions/Graphics/LoadAnimation.md
@@ -1,4 +1,4 @@
-# LoadAnimation <small>(RSDKv3)</small>
+# LoadAnimation
 
 ## Description
 Loads an animation file for the current object type.

diff --git a/docs/RSDKv3/Functions/Graphics/LoadSpriteSheet.md b/docs/RSDKv3/Functions/Graphics/LoadSpriteSheet.md
@@ -1,4 +1,4 @@
-# LoadSpriteSheet <small>(RSDKv3)</small>
+# LoadSpriteSheet
 
 ## Description
 Loads a spritesheet and assigns the ID to `Object.SpriteSheet`. The spritesheet must be a GIF file.

diff --git a/docs/RSDKv3/Functions/Graphics/ProcessAnimation.md b/docs/RSDKv3/Functions/Graphics/ProcessAnimation.md
@@ -1,4 +1,4 @@
-# ProcessAnimation <small>(RSDKv3)</small>
+# ProcessAnimation
 
 ## Description
 Processes the current object's animation, based on the animation file loaded prior via [LoadAnimation()](LoadAnimation.md). The animation is processed based on `Object.Animation`, and uses `Object.AnimationSpeed`, `Object.AnimationTimer`, and `Object.Frame` as well.

diff --git a/docs/RSDKv3/Functions/Graphics/RemoveSpriteSheet.md b/docs/RSDKv3/Functions/Graphics/RemoveSpriteSheet.md
@@ -1,4 +1,4 @@
-# RemoveSpriteSheet <small>(RSDKv3)</small>
+# RemoveSpriteSheet
 
 ## Description
 Removes the given spritesheet from memory, if it is already loaded.

diff --git a/docs/RSDKv3/Functions/Graphics/SpriteFrame.md b/docs/RSDKv3/Functions/Graphics/SpriteFrame.md
@@ -1,4 +1,4 @@
-# SpriteFrame <small>(RSDKv3)</small>
+# SpriteFrame
 
 ## Description
 Adds a SpriteFrame with the specified values.

diff --git a/docs/RSDKv3/Functions/Math/ATan2.md b/docs/RSDKv3/Functions/Math/ATan2.md
@@ -1,4 +1,4 @@
-# ATan2 <small>(RSDKv3)</small>
+# ATan2
 
 ## Description
 Performs an arctan operation using `X` and `Y`, storing the result in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/Cos.md b/docs/RSDKv3/Functions/Math/Cos.md
@@ -1,4 +1,4 @@
-# Cos <small>(RSDKv3)</small>
+# Cos
 
 ## Description
 Gets the value from the `cos512` lookup table based on `Angle` and sets it in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/Cos256.md b/docs/RSDKv3/Functions/Math/Cos256.md
@@ -1,4 +1,4 @@
-# Cos256 <small>(RSDKv3)</small>
+# Cos256
 
 ## Description
 Gets the value from the `cos256` lookup table based on `Angle` and sets it in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/GetBit.md b/docs/RSDKv3/Functions/Math/GetBit.md
@@ -1,4 +1,4 @@
-# GetBit <small>(RSDKv3)</small>
+# GetBit
 
 ## Description
 Gets the binary bit at index `BitPos` from `Value` and stores it in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/Interpolate.md b/docs/RSDKv3/Functions/Math/Interpolate.md
@@ -1,4 +1,4 @@
-# Interpolate <small>(RSDKv3)</small>
+# Interpolate
 
 ## Description
 Linearly interpolates (LERPs) `X` and `Y` by `Percent` and stores the result in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/InterpolateXY.md b/docs/RSDKv3/Functions/Math/InterpolateXY.md
@@ -1,4 +1,4 @@
-# InterpolateXY <small>(RSDKv3)</small>
+# InterpolateXY
 
 ## Description
 Linearly interpolates two points at once, `AX` with `AY`, and `BX` with `BY`, by `Percent`, and stores the result in `StoreX` and `StoreY` respectively.

diff --git a/docs/RSDKv3/Functions/Math/Not.md b/docs/RSDKv3/Functions/Math/Not.md
@@ -1,4 +1,4 @@
-# Not <small>(RSDKv3)</small>
+# Not
 
 ## Description
 Performs a NOT operation on `Value`.

diff --git a/docs/RSDKv3/Functions/Math/Rand.md b/docs/RSDKv3/Functions/Math/Rand.md
@@ -1,4 +1,4 @@
-# Rand <small>(RSDKv3)</small>
+# Rand
 
 ## Description
 Gets a random value from 0 to `Max` (not inclusive) and stores it in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/SetBit.md b/docs/RSDKv3/Functions/Math/SetBit.md
@@ -1,4 +1,4 @@
-# SetBit <small>(RSDKv3)</small>
+# SetBit
 
 ## Description
 Sets index `BitPos` of `Value` to `Bit` and updates `Value` accordingly.

diff --git a/docs/RSDKv3/Functions/Math/Sin.md b/docs/RSDKv3/Functions/Math/Sin.md
@@ -1,4 +1,4 @@
-# Sin <small>(RSDKv3)</small>
+# Sin
 
 ## Description
 Gets the value from the `sin512` lookup table based on `Angle` and sets it in `Store`.

diff --git a/docs/RSDKv3/Functions/Math/Sin256.md b/docs/RSDKv3/Functions/Math/Sin256.md
@@ -1,4 +1,4 @@
-# Sin256 <small>(RSDKv3)</small>
+# Sin256
 
 ## Description
 Gets the value from the `sin256` lookup table based on `Angle` and sets it in `Store`.

diff --git a/docs/RSDKv3/Functions/Misc/AddMenuEntry.md b/docs/RSDKv3/Functions/Misc/AddMenuEntry.md
@@ -1,4 +1,4 @@
-# AddMenuEntry <small>(RSDKv3)</small>
+# AddMenuEntry
 
 ## Description
 Adds an entry to `Menu` with the contents of `Text`. The text will display highlighted if `HighlightEntry` is set to true.

diff --git a/docs/RSDKv3/Functions/Misc/CheckTouchRect.md b/docs/RSDKv3/Functions/Misc/CheckTouchRect.md
@@ -1,4 +1,4 @@
-# CheckTouchRect <small>(RSDKv3)</small>
+# CheckTouchRect
 
 ## Description
 Checks if there's a touch input between the given coordinates.

diff --git a/docs/RSDKv3/Functions/Misc/DrawMenu.md b/docs/RSDKv3/Functions/Misc/DrawMenu.md
@@ -1,4 +1,4 @@
-# DrawMenu <small>(RSDKv3)</small>
+# DrawMenu
 
 ## Description
 Draws `Menu` at `XPos` and `YPos` relative to the screen.

diff --git a/docs/RSDKv3/Functions/Misc/DrawText.md b/docs/RSDKv3/Functions/Misc/DrawText.md
@@ -1,4 +1,4 @@
-# DrawText <small>(RSDKv3)</small>
+# DrawText
 
 ## Description
 Draws the contents of `menu`.

diff --git a/docs/RSDKv3/Functions/Misc/EditMenuEntry.md b/docs/RSDKv3/Functions/Misc/EditMenuEntry.md
@@ -1,4 +1,4 @@
-# EditMenuEntry <small>(RSDKv3)</small>
+# EditMenuEntry
 
 ## Description
 Edits an entry of `Menu` with the contents of `Text` in `RowID`. The text will display highlighted if `HighlightEntry` is set to true.

diff --git a/docs/RSDKv3/Functions/Misc/GetTextInfo.md b/docs/RSDKv3/Functions/Misc/GetTextInfo.md
@@ -1,4 +1,4 @@
-# GetTextInfo <small>(RSDKv3)</small>
+# GetTextInfo
 
 ## Description
 Gets the data of `Type` from `Menu` using `Index` and stores it in `Store`.

diff --git a/docs/RSDKv3/Functions/Misc/GetVersionNumber.md b/docs/RSDKv3/Functions/Misc/GetVersionNumber.md
@@ -1,4 +1,4 @@
-# GetVersionNumber <small>(RSDKv3)</small>
+# GetVersionNumber
 
 ## Description
 Adds a text entry to `Menu` with the engine's version as the text. The text will display highlighted if `HighlightEntry` is set to true.

diff --git a/docs/RSDKv3/Functions/Misc/LoadTextFile.md b/docs/RSDKv3/Functions/Misc/LoadTextFile.md
@@ -1,4 +1,4 @@
-# LoadTextFile <small>(RSDKv3)</small>
+# LoadTextFile
 
 ## Description
 Loads `Menu` based on the text file loaded from `FilePath`.

diff --git a/docs/RSDKv3/Functions/Misc/LoadTextFont.md b/docs/RSDKv3/Functions/Misc/LoadTextFont.md
@@ -1,4 +1,4 @@
-# LoadTextFont <small>(RSDKv3)</small>
+# LoadTextFont
 
 ## Description
 Loads a bitmap font from `FilePath` for use with text menus.

diff --git a/docs/RSDKv3/Functions/Misc/LoadVideo.md b/docs/RSDKv3/Functions/Misc/LoadVideo.md
@@ -1,4 +1,4 @@
-# LoadVideo <small>(RSDKv3)</small>
+# LoadVideo
 
 ## Description
 Loads and plays a video.