API

InfoSettings

Passed into Lionstore.SetInfo

Partitions

number Required

Must be 1+, allocates a DataStore into smaller partitions with limit DataSize/Partitions chars; DataSize is the char limit. More partitions gives you more leeway on restoring past backups but reduces the size of your partitions.

Warning

Once set, you can't change this unless you use a new key

Default

table Required

The default data loaded into a new player. If missing entries of a preloaded profile exists, the data will be reconciled.

DisregardLimitCheck

bool

Don't call JSONDecode whenever you update the data and gets rid of the limit check. Suitable if you're changing data tons of times with large tables and you know it won't be over the partition limit.

HandleLocked

callback(Player: instance, Data: MainData) -> boolean

Calls when the profile is locked and does not load. If true is returned, continue loading.

HandleCorruption

callback(Player: instance, Data: MainData) -> boolean

Calls when the profile is corrupted and does not load. If true is returned, continue loading.

BeforeSave

modifier(Player: instance, Data: table) -> Data

Calls when the profile is about to be saved. Must return profile data. Use to serialize.

BeforeInitialGet

modifier(Player: instance, Data: table) -> Data

Calls when after a value is received from Roblox data stores. Must return profile data. Use to deserialize.

Lionstore

.SetInfo

SetInfo(InfoSettings)

Set lionstore settings.

.read

read(Key: string, PlayerId: int) -> Success: bool, Result: string | table

Grabs the latest revision data from a player of PlayerId with a given DataStore Key. Yields. If unsuccessful, returns string error.

.modify

modify(Key: string, PlayerId: int, Id: string, Args: variant) -> Success: bool, Error?: string

Modifies a player's data regardless of live or not, of PlayerId with a given DataStore Key. Id is the supplied callback key passed in .SetModifier() and supplies it with Args.

.SetModifier

SetModifier(Id: string, Callback: callback(PlayerId: string, Data: table, Args: variant))

Sets a modifier that is called from .modify().

.GetProfile

GetProfile(Player: instance) -> Profile?

Get a profile from the player if it exists.

.new

new(key: string, Player: instance) -> Profile

Makes a new profile.

Profile

:loaded

loaded() -> boolean

Returns whether the data is loaded.

.Loaded

Promise

Allows you to wait for a profile to be loaded. Ex;

if not Profile:loaded() then
    Profile.Loaded:await()
end

:get

get() -> table

Returns the data.

:update

update(modifier(data: table) -> data)

Update the data. Must return profile data.

:habitat

habitat(run: callback(data: table), onCorrupt?: callback(error: string, identifiers?: ...), identifiers?: ...)

Create a habitat where the run callback is passed data. Acts as a pcall. Whenever an error arises, sets profile status to corrupt and calls onCorrupt. Optional identifiers can be passed into the callback.

Info

This is the recommended way to run code in which you are dealing with profile data, no matter if you are getting or setting!

:Lock

Lock()

Yields until the profile is locked. The library automatically locks the profile every 4 minutes so you can forget about this. Adds 10 minutes + os.time to the lock timer.

:Save

Save() -> Promise

Saves the profile. Returns a promise. Sets lock timer to 0 and increments the version number. The library automatically saves the profile when the player leaves.

:SaveAsync

SaveAsync()

:Save but yields the thread.

:isLocked

isLocked() -> boolean

Returns whether the profile is locked.

.Release

BindableEvent

If your profile is locked by another server as it saves, you can connect to this when the profile is released. Don't use :Wait since it may not fire at all.

.MainData

Warning

NILABLE if profile is not loaded. Use :loaded to check!

{
    Corrupted: boolean,
    Data: array
    VERSION: number,
    Locked: number
}

A table describing the player's data.

VERSION is the number of times the player has :Save called,

Data is the array where indices are 1 to Partitions where 1 is the latest data.

Locked is the number signifying if the profile is locked- unix time < Locked.

Corrupted signifies that the profile is corrupted.