Add API reference docs

RyanLua · Dec 22, 2023 · c967178 · c967178
1 parent 0b956df
commit c967178
Show file tree

Hide file tree

Showing 3 changed files with 134 additions and 2 deletions.
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -0,0 +1,131 @@
+Satchel is a reskin of the default BackpackGui located in [CoreGui](https://create.roblox.com/docs/reference/engine/classes/CoreGui). Satchel acts very similar to the default backpack and is based on a fork on the default backpack. Behaviors between the two should remain the same with both of them managing the [Backpack](https://create.roblox.com/docs/reference/engine/classes/Backpack).
+
+## Summary
+
+### Attributes
+
+| Attribute | Description | Default |
+| :--- | :--- | :--- |
+| BackgroundColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the background color of the default inventory window and slots. | `[25, 27, 29]` |
+| BackgroundTransparency: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the background transparency of the default inventory window and slots. | 0.3 |
+| CornerRadius: [`UDim`](https://create.roblox.com/docs/reference/engine/datatypes/UDim) | Determines the radius, in pixels, of the default inventory window and slots. | `0, 8` |
+| EquipBorderColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the equip border when a slot is equipped. | `[255, 255, 255]` |
+| EquipBorderSizePixel: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the pixel width of the equip border when a slot is equipped. | `5` |
+| InsetIconPadding: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the tool icon is padded in the default inventory window and slots. | True |
+| OutlineEquipBorder: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the equip border is outline or inset when a slot is equipped. | True |
+| TextColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text in default inventory window and slots. | `[255, 255, 255]` |
+| TextSize: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the size of the text in the default inventory window and slots. | `14` |
+| TextStrokeColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text stroke of text in default inventory window and slots. | `[0, 0, 0]` |
+| TextStrokeTransparency: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the transparency of the text stroke of text in default chat window and slots. | 0.5 |
+
+### Methods
+
+| IsOpened(): [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) |
+| :--- |
+| Returns whether the inventory is opened or not. |
+
+| SetBackpackEnabled(enabled: boolean): `void` |
+| :--- |
+| Sets whether the backpack gui is enabled or disabled. |
+
+| GetBackpackEnabled(): [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) |
+| :--- |
+| Returns whether the backpack gui is enabled or disabled. |
+
+| GetStateChangedEvent(): [`RBXScriptSignal`](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal) |
+| :--- |
+| Returns a signal that fires when the inventory is opened or closed. |
+
+## Attributes
+
+### BackgroundColor3
+
+Determines the background color of the default inventory window and slots. Changing this will update the background color for all elements excluding the search box background for visibility purposes.
+
+### BackgroundTransparency
+
+Determines the background transparency of the default inventory window and slots. This will change how the hot bar looks in its locked state and the inventory background.
+
+### CornerRadius
+
+Determines the radius, in pixels, of the default inventory window and slots. This will affect all elements with a visible rounded corner. The corner radius for the search bar is calculated automatically based on this value.
+
+### EquipBorderColor3
+
+Determines the color of the equip border when a slot is equipped. The drag outline color of the slot will not changed by this.
+
+### EquipBorderSizePixel
+
+Determines the pixel width of the equip border when a slot is equipped. This additionally controls the padding of tool icons.
+
+### InsetIconPadding
+
+Determines whether or not the tool icon is padded in the default inventory window and slots. Changing this will change how the tool icon is padded in the slot or not.
+
+### OutlineEquipBorder
+
+Determines whether or not the equip border is outline or inset when a slot is equipped. Changing this will make the equip border either border will outline or inset the slot.
+
+### TextColor3
+
+Determines the color of the text in default inventory window and slots. This will change the color of all text.
+
+### TextSize
+
+Determines the size of the text in the default inventory window and slots. This will change the text size of the tool names and will not change other text like search text, hotkey number, and gamepad hints.
+
+### TextStrokeColor3
+
+Determines the color of the text stroke of text in default inventory window and slots. This will change the color of all text strokes which are visible.
+
+### TextStrokeTransparency
+
+Determines the transparency of the text stroke of text in default chat window and slots. This will change all text strokes in which text strokes are visible.
+
+## Methods
+
+### IsOpened
+
+Returns whether the inventory is opened or not.
+
+#### Returns
+
+```
+boolean
+```
+
+### SetBackpackEnabled
+
+Sets whether the backpack gui is enabled or disabled.
+
+#### Parameters
+
+```
+enabled: boolean
+```
+
+#### Returns
+
+```
+void
+```
+
+### GetBackpackEnabled
+
+Returns whether the backpack gui is enabled or disabled.
+
+#### Returns
+
+```
+boolean
+```
+
+### GetStateChangedEvent
+
+Returns a signal that fires when the inventory is opened or closed.
+
+#### Returns
+
+```
+RBXScriptSignal
+```
diff --git a/docs/index.md b/docs/index.md
@@ -20,15 +20,15 @@ This documentation will allow you to install Satchel and learn about how to scri
 
     Made for computers, phone, tablet, console, and VR. Responsive design allows Satchel to adapt to any device
 
-    [:octicons-arrow-right-24: Reference](#)
+    [:octicons-arrow-right-24: API Reference](api-reference)
 
 - :material-toolbox:{ .lg .middle } __Highly customizable__
 
     ---
 
     Change the colors, fonts, language, icons, logo without having to open a script using [instance attributes](https://create.roblox.com/docs/studio/instance-attributes)
 
-    [:octicons-arrow-right-24: Customization](#)
+    [:octicons-arrow-right-24: Customization](usage/#customization)
 
 - :material-scale-balance:{ .lg .middle } __Open Source, MPL-2.0__
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,6 +35,7 @@ nav:
   - Guide:
     - Installation: installation.md
     - Usage: usage.md
+  - API Reference: api-reference.md
 
 markdown_extensions:
   - admonition