Skip to main content

ProfileService

This item only works when running on the server. Server

Internal system for Profiles. This is a standalone version of the ProfileService module from Madwork. It is used to manage player profiles and save data to the DataStore.

Types​

Profile​

</>
interface Profile {
Data: table
MetaData: table
MetaTagsUpdated: Signal
RobloxMetaData: table
UserIds: {number}
KeyInfoUpdated: Signal--

Types.Signal

GlobalUpdates: GlobalUpdates
IsActive: (Profile) → boolean
GetMetaTag: (
Profile,
tagName: string
) → any
Reconcile: (Profile) → ()
ListenToRelease: (
Profile,
listener: (
placeId: number?,
game_job_Id: number?
) → ()
) → RBXScriptConnection
Release: (Profile) → ()
ListenToHopReady: (
Profile,
listener: () → ()
) → RBXScriptConnection
AddUserId: (
Profile,
userId: number
) → ()
RemoveUserId: (
Profile,
userId: number
) → ()
Identify: (Profile) → string
SetMetaTag: (
Profile,
tagName: string,
value: DataStoreSupportedValue
) → ()
Save: (Profile) → ()
ClearGlobalUpdates: (Profile) → ()
OverwriteAsync: (Profile) → ()
}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "Profile",
            "desc": "",
            "fields": [
                {
                    "name": "Data",
                    "lua_type": "table",
                    "desc": ""
                },
                {
                    "name": "MetaData",
                    "lua_type": "table",
                    "desc": ""
                },
                {
                    "name": "MetaTagsUpdated",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "RobloxMetaData",
                    "lua_type": "table",
                    "desc": ""
                },
                {
                    "name": "UserIds",
                    "lua_type": "{number",
                    "desc": ""
                },
                {
                    "name": "KeyInfo",
                    "lua_type": "DataStoreKeyInfo",
                    "desc": ""
                },
                {
                    "name": "KeyInfoUpdated",
                    "lua_type": "Signal",
                    "desc": "Types.Signal<DataStoreKeyInfo>"
                },
                {
                    "name": "GlobalUpdates",
                    "lua_type": "GlobalUpdates",
                    "desc": ""
                },
                {
                    "name": "IsActive",
                    "lua_type": "(Profile) -> boolean",
                    "desc": ""
                },
                {
                    "name": "GetMetaTag",
                    "lua_type": "(Profile, tagName: string) -> any",
                    "desc": ""
                },
                {
                    "name": "Reconcile",
                    "lua_type": "(Profile) -> ()",
                    "desc": ""
                },
                {
                    "name": "ListenToRelease",
                    "lua_type": "(Profile, listener: (placeId: number?, game_job_Id: number?) -> ()) -> RBXScriptConnection",
                    "desc": ""
                },
                {
                    "name": "Release",
                    "lua_type": "(Profile) -> ()",
                    "desc": ""
                },
                {
                    "name": "ListenToHopReady",
                    "lua_type": "(Profile, listener: () -> ()) -> RBXScriptConnection",
                    "desc": ""
                },
                {
                    "name": "AddUserId",
                    "lua_type": "(Profile, userId: number) -> ()",
                    "desc": ""
                },
                {
                    "name": "RemoveUserId",
                    "lua_type": "(Profile, userId: number) -> ()",
                    "desc": ""
                },
                {
                    "name": "Identify",
                    "lua_type": "(Profile) -> string",
                    "desc": ""
                },
                {
                    "name": "SetMetaTag",
                    "lua_type": "(Profile, tagName: string, value: DataStoreSupportedValue) -> ()",
                    "desc": ""
                },
                {
                    "name": "Save",
                    "lua_type": "(Profile) -> ()",
                    "desc": ""
                },
                {
                    "name": "ClearGlobalUpdates",
                    "lua_type": "(Profile) -> ()",
                    "desc": ""
                },
                {
                    "name": "OverwriteAsync",
                    "lua_type": "(Profile) -> ()",
                    "desc": ""
                }
            ],
            "source": {
                "line": 33,
                "path": "src/playerprofilemanager/src/Server/_ProfileType.lua"
            }
        }
    ],
    "name": "ProfileService",
    "desc": "Internal system for Profiles. This is a standalone version of the ProfileService module from Madwork. It is used to manage player profiles and save data to the DataStore.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/profileservice/src/Server/ProfileService.lua"
    }
}