Skip to content

Purse Documentation

API Reference

API Reference

Purse unlocks APIs for the CoreGui backpack which were previously locked to other CoreGui scripts. To access the APIs, just require Purse like any other module script:

Toggle Inventory Example
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local Purse = require(ReplicatedStorage.Purse)

Purse.OpenClose() -- Toggle the inventory

Methods¶

OpenClose¶

Toggles the backpack open/closed state. If the backpack is currently open, it will close it. If closed, it will open it.

Properties¶

IsHotbarVisible¶

Returns if the hotbar is currently visible to the player.

Returns¶

IsOpen¶

Returns if the inventory is currently open to the player.

Returns¶

ModuleName¶

Returns the module name. This will always return "Backpack".

Returns¶

KeepVRTopbarOpen¶

Returns true.

Returns¶

VRIsExclusive¶

Returns true.

Returns¶

VRClosesNonExclusive¶

Returns true.

Returns¶

IsInventoryEmpty¶

Returns if the inventory is empty.

Returns¶

Events¶

StateChanged¶

Fires when the backpack is closed or opened.

Returns¶

BackpackEmpty¶

Fires when the inventory is empty.

Returns¶

BackpackItemAdded¶

Fires when a item is added to the inventory.

Returns¶

BackpackItemRemoved¶

Fires when a item is removed from the inventory.

Returns¶