Skip to main content

TieRealmService

Functions​

SetTieRealm​

</>
TieRealmService.SetTieRealm(
tieRealm: TieRealms.TieRealm
) → ()

Sets the tie realm for this service bag

HasExplicitTieRealm​

</>
TieRealmService.HasExplicitTieRealm(self: TieRealmService) → boolean

Returns whether the realm was set with TieRealmService.SetTieRealm rather than inferred.

RunService reports the server even when the game is not running, such as in Studio edit mode or a headless test. A service whose server behavior is unsafe there can keep its own inference unless the bag was told a realm.

GetTieRealm​

</>
TieRealmService.GetTieRealm(self: TieRealmService) → TieRealms.TieRealm

Get the tie realm for this service bag

Show raw api
{
    "functions": [
        {
            "name": "SetTieRealm",
            "desc": "Sets the tie realm for this service bag",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieRealmService"
                },
                {
                    "name": "tieRealm",
                    "desc": "",
                    "lua_type": "TieRealms.TieRealm"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "src/tie/src/Shared/Services/TieRealmService.lua"
            }
        },
        {
            "name": "HasExplicitTieRealm",
            "desc": "Returns whether the realm was set with [TieRealmService.SetTieRealm] rather than inferred.\n\n[RunService] reports the server even when the game is not running, such as in Studio edit mode\nor a headless test. A service whose server behavior is unsafe there can keep its own inference\nunless the bag was told a realm.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieRealmService"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/tie/src/Shared/Services/TieRealmService.lua"
            }
        },
        {
            "name": "GetTieRealm",
            "desc": "Get the tie realm for this service bag",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieRealmService"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieRealms.TieRealm\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/tie/src/Shared/Services/TieRealmService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TieRealmService",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/tie/src/Shared/Services/TieRealmService.lua"
    }
}