Fix markdownlint warning

ReScrap · May 12, 2024 · ee9838b · ee9838b
1 parent 38fd0f6
commit ee9838b
Show file tree

Hide file tree

Showing 13 changed files with 894 additions and 158 deletions.
diff --git a/src/Callbacks.md b/src/Callbacks.md
@@ -1,4 +1,7 @@
+# C++ Callbacks
+
 They can be used in function parameters like so:
+
 ```python
 SAct.SetAct("EventFunc","!<Callback_Name>")
 ```
@@ -18,13 +21,13 @@ Scrap.Execute()
 
 Note the `!` symbol in front of the callback name
 
-# Parameters
+## Parameters
 
 - EditText:
-	- player_id: int
-	- scorer_item_name: str
+  - player_id: int
+  - scorer_item_name: str
 
-## OG
+### OG
 
 | Callback setup address | Callback name                | Callback funcion                       | Callback address |
 |------------------------|------------------------------|----------------------------------------|------------------|
@@ -204,8 +207,7 @@ Note the `!` symbol in front of the callback name
 | `004d3ba0`             | "ChangeDoorState"            | `callbacks.ChangeDoorState`            | `004d3bc0`       |
 | `004c91c0`             | "PoliceEndActionMoney"       | `callbacks.PoliceEndActionMoney`       | `004c91e0`       |
 
-
-## Remaster
+### Remaster
 
 | Callback setup address | Callback name                | Callback funcion | Callback address |
 |------------------------|------------------------------|------------------|------------------|
@@ -383,4 +385,4 @@ Note the `!` symbol in front of the callback name
 | `0043e960`             | "AnmSoundEvent"              | `FUN.00465720`   | `00465720`       |
 | `0044cbe0`             | "TeslaPress"                 | `FUN.00528bd0`   | `00528bd0`       |
 | `00448c60`             | "ATPCCreate"                 | `FUN.0051c3e0`   | `0051c3e0`       |
-| `004413c0`             | "BankDirectorEndActionInit"  | `FUN.004c1000`   | `004c1000`       |
+| `004413c0`             | "BankDirectorEndActionInit"  | `FUN.004c1000`   | `004c1000`       |
diff --git a/src/Chunked.md b/src/Chunked.md
@@ -1,6 +1,6 @@
 # Chunked Formats
 
-# General Block format
+## General Block format
 
 ```cpp
 struct Block {
@@ -17,7 +17,7 @@ struct Block {
 }
 ```
 
-# Block IDs
+## Block IDs
 
 | File ID | Chunk IDs                                                                      |
 | ------- | ------------------------------------------------------------------------------ |
@@ -36,32 +36,32 @@ Read types:
 - `3f`: array of 3 4-byte floats
 - `3i`: array of 3 4-byte unsigned integers
 
-| Chunk ID | Description                 | Reads                    |
-| -------- | --------------------------- | ------------------------ |
-| AMC      | Collision Data              |
-| ANI      | Animation data?             |
-| CAM      | Camera info?                |
-| CMSH     | Collision Mesh Data         |
-| EVA      | Vertex animation data       |
-| DUM      | Dummy (map object) data     |
-| INI      | INI-Configuration data      |
-| LFVF     | FVF Vertex Data             |
-| LUZ      | Lighting information        |
-| MAP      | Lightmap                    |
-| MAT      | Material information        |
-| NAE      | Animation Data?             |
-| NAM      | Animation Data?             |
-| PORT     | Map portals                 | `i==1, i, i, 4, 4`
-| QUAD     | Mesh data?                  |
-| SCN      | Scene tree data             |
-| SUEL     | Ground Plane?               | 0x18, 0xc, 4, 4, 4, 0x18
-| TRI      | Triangle Mesh               |
-| MD3D     | 3D Model definition         |
-| EMI      | Level geometry              |
-
-# Format of Specific chunks
-
-## INI
+| Chunk ID | Description             | Reads                    |
+| -------- | ----------------------- | ------------------------ |
+| AMC      | Collision Data          |                          |
+| ANI      | Animation data?         |                          |
+| CAM      | Camera info?            |                          |
+| CMSH     | Collision Mesh Data     |                          |
+| EVA      | Vertex animation data   |                          |
+| DUM      | Dummy (map object) data |                          |
+| INI      | INI-Configuration data  |                          |
+| LFVF     | FVF Vertex Data         |                          |
+| LUZ      | Lighting information    |                          |
+| MAP      | Lightmap                |                          |
+| MAT      | Material information    |                          |
+| NAE      | Animation Data?         |                          |
+| NAM      | Animation Data?         |                          |
+| PORT     | Map portals             | `i==1, i, i, 4, 4`       |
+| QUAD     | Mesh data?              |                          |
+| SCN      | Scene tree data         |                          |
+| SUEL     | Ground Plane?           | 0x18, 0xc, 4, 4, 4, 0x18 |
+| TRI      | Triangle Mesh           |                          |
+| MD3D     | 3D Model definition     |                          |
+| EMI      | Level geometry          |                          |
+
+## Format of Specific chunks
+
+### INI
 
 Configuration Data
 
@@ -78,7 +78,7 @@ struct INI {
 };
 ```
 
-## LFVF
+### LFVF
 
 DirectX Flexible Vertex Format Data
 
@@ -106,7 +106,7 @@ struct LFVF {
 };
 ```
 
-## DUM
+### DUM
 
 Map object data
 
@@ -129,7 +129,7 @@ struct DUM {
 };
 ```
 
-## MAP
+### MAP
 
 ```cpp
 struct MAP {
@@ -140,11 +140,11 @@ struct MAP {
 }
 ```
 
-## SCN
+### SCN
 
 - Tree structure
 
-```
+```text
 Escena: Models/Chars/Dtritus/Dtritus.M3D
   _raiz_escena                                       -1   0  -1  c:(null)    f:00000001  a:0000
     DC_Root                                           0   1  -1  c:(null)    f:00010090  a:0000
@@ -241,4 +241,4 @@ Escena: Models/Chars/Dtritus/Dtritus.M3D
                     R_Detritus_Espinilla-CilindroA_Der      136  90  -1  c:MallaD3D  f:00000010  a:0000
                 R_Detritus_Pierna_Der               138  91  -1  c:MallaD3D  f:00000010  a:0000  [skin]
                   R_Detritus_Pierna-CilindroA_Der   139  92  -1  c:MallaD3D  f:00000010  a:0000
-```
+```
diff --git a/src/Classes.md b/src/Classes.md
@@ -31,27 +31,26 @@
 
 ## Class Inheritance
 
-
 ```mermaid
 graph LR
     World
     ActionClassList
     SaveVar
-	Window --> App 
-	CamPath --> Cam
-	Cam --> Entity
-	FCam --> Cam
-	Obj --> Entity
-	item --> Obj
-	WithLife --> Obj
-	Car --> WithLife
-	WalkChar --> WithLife
-	Missile --> WithLife
+    Window --> App 
+    CamPath --> Cam
+    Cam --> Entity
+    FCam --> Cam
+    Obj --> Entity
+    item --> Obj
+    WithLife --> Obj
+    Car --> WithLife
+    WalkChar --> WithLife
+    Missile --> WithLife
 ```
 
-# Attributes (VMT index 16,17,18 for accessor functions)
+## Attributes (VMT index 16,17,18 for accessor functions)
 
-## Entity
+### Entity
 
 - LLogic
 - Name
@@ -60,7 +59,7 @@ graph LR
 - NextInSlot
 - NextInList
 
-## FCam
+### FCam
 
 - OnSwitch
 - QuakeFactor
@@ -78,38 +77,35 @@ graph LR
 - AddTurn
 - AddTurnSpeed
 
-## Cam
+### Cam
 
 - Fov
 - clipNear
 - clipFar
-- 
-
-
 
-## Obj
+### Obj
 
 - OnEndMove
 - CamName
 - NetRes
 - OnObjSlot
 - LinkModel?
 
-## item 
+### item
 
 - TakeSound
 - OnReset
 - OnTake
 - Owner
 - TgTypeMarker
 
-## Car
+### Car
 
 - Traf
 - Model
 - Target
 
-## WithLife
+### WithLife
 
 - Descriptor
 - Attacker
@@ -128,4 +124,4 @@ graph LR
 - ArriOpt
 - UseAngSel
 - UseMapCheck
-- UseAbsAngSel
+- UseAbsAngSel
diff --git a/src/File.md b/src/File.md
@@ -1,17 +1,16 @@
 # File Formats
 
-
- File Extension | Description              | Chunked 
- -------------- | ------------------------ | ------- 
- .packed        | Game Data Archive        | n       
- .cm3           | Animation file           | y       
- .sm3           | 3d model file            | y       
- .dum           | Dummy (map object) file  | y       
- .pth           | AI Path                  | n       
- .emi           | Level geometry           | y       
- .amc           | Collision Data           | y       
- .ini           | Configuration            | n       
- .txa           | Texture Animation Config | n       
+| File Extension | Description              | Chunked |
+| -------------- | ------------------------ | ------- |
+| .packed        | Game Data Archive        | n       |
+| .cm3           | Animation file           | y       |
+| .sm3           | 3d model file            | y       |
+| .dum           | Dummy (map object) file  | y       |
+| .pth           | AI Path                  | n       |
+| .emi           | Level geometry           | y       |
+| .amc           | Collision Data           | y       |
+| .ini           | Configuration            | n       |
+| .txa           | Texture Animation Config | n       |
 
 - [Chunked](Chunked.md)
 - [Packed](Packed.md)

diff --git a/src/MultiSpriteTable.md b/src/MultiSpriteTable.md
@@ -1,3 +1,4 @@
+# Multi Sprite Table (.mst)
 
 ```cpp
 struct Tile {
@@ -13,4 +14,4 @@ struct MST {
     uint32_t num_tiles; // number of tiles/subsprites
     Tile tiles[num_tiles];
 }
-```
+```
diff --git a/src/PE_metadata.md b/src/PE_metadata.md
@@ -92558,4 +92558,4 @@ COMCTL32.dll Ordinal[17] (Imported by Ordinal)
     003FA3E4h HIGHLOW
     003FA778h HIGHLOW
     003FA000h ABSOLUTE
-```
+```
diff --git a/src/Packed.md b/src/Packed.md
@@ -12,4 +12,4 @@ struct Header {
         uint32_t data_offset; // offset includes header size so it can be used directly in a seek() call
     } files[];
 };
-```
+```