Methods

An overview of all the methods available on both DataService and DataController.

GET Methods

Methods for getting player data, can be used on both client and server with the same code structure.

GetProfile

Gets all the data from a player, though on client it will not return data that has not been replicated.

Parameters:

1. player : Player -> Player who you want the data profile from.

2. timeOut : number? -> Max amount of time it will wait for the data (default is infinite).

3. usePromise : boolean? -> If set to true, it returns a promise instead and won't yield your code.

Returns a player profile, if successful.

Examples:

• Not using promise:

local playerProfile = DataController:GetProfile(player, 20, false) -- Yields
if not playerProfile then return end --// Profile could not be loaded

• Using promise:

DataController:GetProfile(player, 20, true):andThen(function(playerProfile)
    if not playerProfile then return end --// Profile could not be loaded
    --// Yay, profile loaded!!
end):catch(warn)

GetData

Gets a specific data from a player based on the data name, will return nil if you attempt to get a data that is not being replicated to the client or that does not exist in its profile.

Parameters:

1. player : Player -> Player who you want the data from.

2. dataName : string -> Name of the data you want to get from the player.

3. timeOut : number? -> Max amount of time it will wait for the data (default is infinite).

4. usePromise : boolean? -> If set to true, it returns a promise instead and won't yield your code.

Returns the data requested, if successful.

Examples:

• Not using promise:

local playerCoins = DataController:GetData(player, "Coins", 20, false) -- Yields
if not playerCoins then return end --// Profile could not be loaded
--// Yay, my Coins data is here!!

• Using promise:

DataController:GetData(player, "Coins", 20, true):andThen(function(playerCoins)
    if not playerCoins then return end --// Profile could not be loaded
    --// Yay, my Coins data is here!!
end):catch(warn)

---

POST Methods

Methods used to edit data, only available in the Server side, which means through DataService.

Add

Used to add into a number type data (pretty much doing a Data + Number).

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : number -> Value that will get added into the data, must NOT be negative.

Returns the new Data Value, if successful.

Example:

• Increasing a player's coins by 5:

local newCoins = DataService:Add(player, "Coins", 5)
print(newCoins) --// Assuming the player had 5 coins before, it will print 10.

Sub

Used to subtract from a number type data (pretty much doing a Data - Number).

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : number -> Value that will get subtracted from the data, must NOT be negative.

Returns the new Data Value, if successful.

Example:

• Decreasing a player's coins by 5:

local newCoins = DataService:Sub(player, "Coins", 5)
print(newCoins) --// Assuming the player had 10 coins before, it will print 5.

Set

Used to edit any data in the player, completely overwriting any old one that was previously in the same data name.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : any-> Value that will get set into the data, overwriting the old one.

Returns the new Data Value, if successful.

Example:

• Setting a player's coins to 100:

local newCoins = DataService:Set(player, "Coins", 100)
print(newCoins) --// It will print 100.

ArrayInsert

Used to insert a value into an array type data.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : any-> Value that will get inserted into the data.

Returns the new Data Value, if successful.

Example:

• Inserting a Premium gamepass reference into a player's "Gamepasses" data:

local newGamepassesArray= DataService:ArrayInsert(player, "Gamepasses", "Premium")
print(newGamepassesArray) 
--// Assuming the player didn't have other gamepasses before, 
--// it will print {"Premium"}.

ArrayRemove

Used to remove a data value from an array type data through the value index.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. index : number -> Numeric index of the value you want to remove from the data.

Returns the new Data Value, if successful.

Example:

• Removing a Premium gamepass reference from a player's "Gamepasses" data:

--// Only example, don't copy and paste this code as it has no safety due to 
--// table.find possibly returning nil, or the player leaving before the GetData returns.
local playerGamepasses = DataService:GetData(Player, "Gamepasses") --// Yields
local index = table.find(playerGamepasses, "Premium") --// Gets the index

local newGamepassesArray= DataService:ArrayRemove(player, "Gamepasses", index)
print(newGamepassesArray)
--// Assuming the player had only premium before, 
--// it will print {}.

ArraySet

Used to set a data into the given array, overwriting any old values inside it.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : {any} -> Value that will get set into the data, overwriting the old one.

Returns the new Data Value, if successful.

Examples:

• Setting a player's gamepasses data to have VIP and Premium:

local newGamepasses = DataService:ArraySet(player, "Gamepasses", {
    "VIP", "Premium"
})
print(newGamepasses ) --// It will print {"VIP", "Premium"}.

DictionaryInsert

Inserts a value inside a dictionary type of data, based on the given index.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. value : number -> Value that will get set into the index, overwriting the old one.

4. index : number | string -> The index that the value will get inserted at, will overwrite any value that might be in the same index.

Returns the new Data Value, if successful.

Examples:

• Inserting a sword item into a player's inventory:

local swordId = "CoolSword_28483"
local swordData = {
    Id = swordId,
    Damage = 5,
    Upgrades = 0
}

local newInventoryData = DataService:DictionaryInsert(Player, "Inventory", swordData, swordId)
print(newInventoryData) 
--[[ 
Assuming the player had no other items in his inventory:
Output: {
    ["CoolSword_28483"] = {
        Id = "CoolSword_28483",
        Damage = 5,
        Upgrades = 0
    }
}
--]]

DictionaryRemove

Removes a value from a dictionary type of data, based on its index.

Parameters:

1. player : Player -> Player who you want to modify the data.

2. dataName : string -> Name of the data.

3. index : number | string -> Index of the value to be removed.

Returns the new Data Value, if successful.

Examples:

• Removing a sword from a player's inventory, following the same context of the DictionaryInsert example:

local swordId = "CoolSword_28483"
local newInventoryData = DataService:DictionaryRemove(Player, "Inventory", swordId)
print(newInventoryData) 
--// Assuming the player had no other items in his inventory:
--// Output: {}

---

Bindings

Methods for binding callbacks whenever a specific data changes, or even all data, of a given player. It can also be used on both DataController and DataService.

Bind

Binds a callback to be run whenever the given data is changed in the given player.

Parameters:

1. player : Player -> Player who you want the data profile from.

2. dataName : string -> Data name to bind, whenever it changes it will trigger the callback.

3. callback : function -> function to be run whenever the data changes.

Doesn't really return anything.

Example:

• Printing the player EXP whenever it gets changed:

DataController:Bind(Player, "EXP", function(newEXP)
    print(Player.Name .. "'s EXP is now: " .. newEXP)
    --// Assuming the player exp changed to 50 and the player name is "InKrnl":
    --// Output: "InKrnl's EXP is now 50"
end)

Bind

Binds a callback to be run whenever any data of given player is changed.

Parameters:

1. player : Player -> Player who you want the data profile from.

2. callback : function -> function to be run whenever the data changes.

Doesn't really return anything.

Example:

• Printing whenever any data of the player is changed:

DataController:BindAll(Player, function(newValue: any, dataName: string)
    print(Player.Name .. "'s [".. dataName .. "] is now: " .. tostring(newValue))
    --// Assuming the player Coins changed to 150 and the player name is "InKrnl":
    --// Output: "InKrnl's [Coins] is now 50"
end)