Skip to main content

instanceNetworkOwnerUtil

An utility module for working with instance network ownership.

Functions​

safeSetInstanceNetworkOwner​

</>
instanceNetworkOwnerUtil.safeSetInstanceNetworkOwner(
instance: BasePart,
networkOwner: Player?
) → ()

Sets the network owner of instance to networkOwner safely.

Safe to call

This method should be preferred over directly setting the network owner of instance via SetNetworkOwner, as it won't error in cases where the network ownership API cannot be used on instance.

safeInstanceNetworkOwner​

</>
instanceNetworkOwnerUtil.safeInstanceNetworkOwner(instance: BasePart) → Player?

Returns the network owner of instance safely.

Safe to call

This method should be preferred over directly getting the network owner of instance via GetNetworkOwner, as it will safely return nil (instead of erroring) in cases where the network ownership API cannot be used on instance!

Show raw api
{
    "functions": [
        {
            "name": "safeSetInstanceNetworkOwner",
            "desc": "Sets the network owner of `instance` to `networkOwner` *safely*.\n\n:::tip Safe to call\nThis method should be preferred over directly setting the network owner of `instance` \nvia [SetNetworkOwner](https://create.roblox.com/docs/reference/engine/classes/BasePart#SetNetworkOwner), as\nit won't error in cases where the network ownership API cannot be used on `instance`.\n::: ",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "networkOwner",
                    "desc": "",
                    "lua_type": "Player?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/instanceNetworkOwnerUtil/init.luau"
            }
        },
        {
            "name": "safeInstanceNetworkOwner",
            "desc": "Returns the network owner of `instance` *safely*.\n\n:::tip Safe to call\nThis method should be preferred over directly getting the network owner of `instance` \nvia [GetNetworkOwner](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetNetworkOwner), as\nit will safely return `nil` (instead of erroring) in cases where the network ownership API cannot be used on `instance`!\n::: ",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Player?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/instanceNetworkOwnerUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "instanceNetworkOwnerUtil",
    "desc": " \n\nAn utility module for working with instance network ownership.",
    "source": {
        "line": 6,
        "path": "src/instanceNetworkOwnerUtil/init.luau"
    }
}