Usage
Use of Satchel after installation very easy. Just publish your experience to Roblox and see Satchel live in action.
Note
Please see API Reference for more details on attributes, methods, and events for Satchel and how to use Satchel to it's full potential.
Satchel is highly customizable & adjustable with instance attributes support allowing you to customize the behavior and appearance of over 10+ attributes. Below see a table containing all the attributes along with a description of what that attribute does.
| Attribute | Description | Default |
|---|---|---|
BackgroundColor3: Color3
|
Determines the background color of the default inventory window and slots. | [25, 27, 29] |
BackgroundTransparency: number
|
Determines the background transparency of the default inventory window and slots. | 0.3 |
CornerRadius: UDim
|
Determines the radius, in pixels, of the default inventory window and slots. | 0, 8 |
EquipBorderColor3: Color3
|
Determines the color of the equip border when a slot is equipped. | [255, 255, 255] |
EquipBorderSizePixel: number
|
Determines the pixel width of the equip border when a slot is equipped. | 5 |
FontFace: Font
|
Determines the font of the default inventory window and slots. | Gotham SSm |
InsetIconPadding: boolean
|
Determines whether or not the tool icon is padded in the default inventory window and slots. | True |
OutlineEquipBorder: boolean
|
Determines whether or not the equip border is outline or inset when a slot is equipped. | True |
TextColor3: Color3
|
Determines the color of the text in default inventory window and slots. | [255, 255, 255] |
TextSize: number
|
Determines the size of the text in the default inventory window and slots. | 14 |
TextStrokeColor3: Color3
|
Determines the color of the text stroke of text in default inventory window and slots. | [0, 0, 0] |
TextStrokeTransparency: number
|
Determines the transparency of the text stroke of text in default chat window and slots. | 0.5 |
Example of customization using instance attributes
Satchel offers methods and events for scripting purposes. Below see a table with all the methods available.
IsOpened(): boolean
|
|---|
| Returns whether the inventory is opened or not. |
SetBackpackEnabled(enabled: boolean): void
|
|---|
| Sets whether the backpack gui is enabled or disabled. |
GetBackpackEnabled(): boolean
|
|---|
| Returns whether the backpack gui is enabled or disabled. |
GetStateChangedEvent(): RBXScriptSignal
|
|---|
| Returns a signal that fires when the inventory is opened or closed. |