Skip to content

Commit

Permalink
Update returns
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanLua committed May 15, 2024
1 parent 5bef7ca commit 2a9bf48
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ description: Satchel is a reskin of the default BackpackGui. Satchel acts very s
icon: material/book-outline
---

<style>
.md-typeset__table {
width: 100%;
}

.md-typeset__table table:not([class]) {
display: table
}
</style>

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
Expand Down Expand Up @@ -105,32 +115,53 @@ Returns whether the inventory is opened or not.

#### Returns

```boolean```
<table>
<tr>
<td><a href="https://create.roblox.com/docs/luau/booleans">bool</a></td>
</tr>
</table>

### SetBackpackEnabled

Sets whether the backpack gui is enabled or disabled.

#### Parameters

```enabled: boolean```
<table>
<tr>
<td>enabled: <a href="https://create.roblox.com/docs/luau/booleans">bool</a></td>
<td>Whether to enable or disable the Backpack</td>
</tr>
</table>

#### Returns

```void```
<table>
<tr>
<td>void</td>
</tr>
</table>

### GetBackpackEnabled

Returns whether the backpack gui is enabled or disabled.

#### Returns

```boolean```
<table>
<tr>
<td><a href="https://create.roblox.com/docs/luau/booleans">bool</a></td>
</tr>
</table>

### GetStateChangedEvent

Returns a signal that fires when the inventory is opened or closed.

#### Returns

```RBXScriptSignal```
<table>
<tr>
<td><a href="https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal">RBXScriptSignal</a></td>
</tr>
</table>

0 comments on commit 2a9bf48

Please sign in to comment.