PlayerProfileManager

This item only works when running on the server. Server

Show Private

This class is responsible for managing player profiles. It provides simple interfaces for handling player profile loading, reconciliation, and data migration.

It is a singleton class, so calling PlayerProfileManager.new multiple times will return the same instance. It is recommended to create a PlayerDataService to manage this class.

Types

DataMigrator

</>

interface DataMigrator {

FromVersion: string

ToVersion: string

Migrate: (

profileData: table,

profileOwner: Player

) → (table)

}

Used to Transform data from one version to another

-- Turn all the deprecated currency 'Candy' into the new currency 'Gems' at a  1:10 rate
local migrator = {
    FromVersion = "0.0.1",
    ToVersion = "0.0.2"
    Migrate = function(data: table, plr: Player)
        if not data.Gems then
            data.Gems = 0
        end

        local candy = data.Candy or 0
        data.Gems += candy * 10
        data.Candy = nil

        return data
    end
}

PPM_Config

</>

interface PPM_Config {

DataStoreKey: string

DefaultDataSchema: table

UseMock: boolean?

Migrator: {DataMigrator}

GetPlayerKeyCallback: ((player: Player) → (string))?

ReconcileCallback: ((

player: Player,

profile: Profile

) → ())?

OnProfileLoadFailureCallback: ((

player: Player,

err: string

) → ())?

}

• DataStoreKey is the internal Key used for the PlayerData's DataStore.

• DefaultDataSchema is a template table that is used for reconciling the player's profile with. It is what new players are given if they dont have existing data.

• UseMock determines whether or not a Mock ProfileStore will be used.

• Migrator is a table of DataMigrators that are used to transform data from one version to another.

• GetPlayerKeyCallback is a callback that is used to fetch the Key that each player's data is mapped to.

• ReconcileCallback is a callback that is called when the system attempts to reconcile the players profile. It will default to calling Profile:Reconcile if not provided.

• OnProfileLoadFailureCallback is a callback that is called if the player's data fails to load. It will default to kicking the player if not provided.

Functions

new

</>

PlayerProfileManager.new(config: PPM_Config) → PlayerProfileManager

Creates a new PlayerProfileManager. This is a singleton class, so calling this function multiple times will return the same instance. Takes a config table, see PPM_Config for more info on the individual fields it supports.

PlayerProfileManager.new({
    DataStoreKey = "PlayerData";
    DefaultDataSchema = {
        __VERSION = "0.0.0";
        Currency = 0;
    };
})

IsLoaded

</>

PlayerProfileManager:IsLoaded(player: Player) → boolean

Returns whether or not the player's profile is currently loaded.

local isLoaded = PlayerProfileManager:IsLoaded(player)

OnLoaded

</>

PlayerProfileManager:OnLoaded(player: Player) → Promise<()>

Returns a promise that will resolve when the player's profile is loaded. Rejects if the player leaves or the profile fails to load.

PlayerProfileManager:OnLoaded(player):andThen(function()
    print("Profile loaded for " .. player.Name)
end)

GetProfile

</>

PlayerProfileManager:GetProfile(player: Player) → Profile?

Returns the player's profile, if it exists. May return nil if this players profile is not loaded.

local profile: Profile? = PlayerProfileManager:GetProfile(player)

PromiseProfile

</>

PlayerProfileManager:PromiseProfile(player: Player) → Promise<Profile>

Returns a promise that resolves with the player's profile when it is ready. Rejects if the player leaves or the profile fails to load.

PlayerProfileManager:PromiseProfile(player):andThen(function(profile: Profile)
    print("Profile loaded for " .. player.Name)
end)