Skip to main content

PlayerDataStoreService

This item only works when running on the server. Server

Centralized service using serviceBag. This will let other packages work with a single player datastore service.

Functions​

Init​

</>
PlayerDataStoreService.Init(
serviceBag: ServiceBag
) → ()

Initializes the PlayerDataStoreService. Should be done via ServiceBag.Init.

Start​

</>
PlayerDataStoreService.Start(self: PlayerDataStoreService) → ()

Initializes the datastore service for players. Should be done via ServiceBag.Start.

SetDataStoreName​

</>
PlayerDataStoreService.SetDataStoreName(
dataStoreName: string
) → ()

Sets the name for the datastore to retrieve.

INFO

Must be done before start and after init.

SetDataStoreScope​

</>
PlayerDataStoreService.SetDataStoreScope(
dataStoreScope: string
) → ()

Sets the scope for the datastore to retrieve.

INFO

Must be done before start and after init.

PromiseDataStore​

</>
PlayerDataStoreService.PromiseDataStore(
player: Player | number
) → Promise<DataStore>

Gets the datastore for the player.

TIP

If you get the datastore by UserId, be sure to call datastore:PromiseCloseSession() when done to avoid session leaks.

PromiseAddRemovingCallback​

</>
PlayerDataStoreService.PromiseAddRemovingCallback(
callback: function--

May return a promise

) → Promise

Adds a removing callback to the manager.

PromiseManager​

</>
PlayerDataStoreService.PromiseManager(self: PlayerDataStoreService) → Promise<PlayerDataStoreManager>

Retrieves the manager

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the PlayerDataStoreService. Should be done via [ServiceBag.Init].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Initializes the datastore service for players. Should be done via [ServiceBag.Start].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "SetDataStoreName",
            "desc": "Sets the name for the datastore to retrieve.\n\n:::info\nMust be done before start and after init.\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                },
                {
                    "name": "dataStoreName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 69,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "SetDataStoreScope",
            "desc": "Sets the scope for the datastore to retrieve.\n\n:::info\nMust be done before start and after init.\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                },
                {
                    "name": "dataStoreScope",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 86,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "PromiseDataStore",
            "desc": "Gets the datastore for the player.\n\n:::tip\nIf you get the datastore by UserId, be sure to call datastore:PromiseCloseSession()\nwhen done to avoid session leaks.\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<DataStore>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "PromiseAddRemovingCallback",
            "desc": "Adds a removing callback to the manager.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService"
                },
                {
                    "name": "callback",
                    "desc": "May return a promise",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        },
        {
            "name": "PromiseManager",
            "desc": "Retrieves the manager",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDataStoreService\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<PlayerDataStoreManager>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 132,
                "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerDataStoreService",
    "desc": "Centralized service using serviceBag. This will let other packages work with a single player datastore service.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/datastore/src/Server/PlayerDataStoreService.lua"
    }
}