Skip to main content

DropletClientManager

This item only works when running on the client. Client

Functions​

new​

constructor
</>
DropletClientManager.new() → DropletClientManager

Creates a new DropletClientManager if one has not already been made, returns the existing one if one already exists.

RegisterResourceType​

</>
DropletClientManager:RegisterResourceType(
resourceType: string,
) → ()

Registers a new resource type.

GetResourceTypeData​

</>
DropletClientManager:GetResourceTypeData(resourceType: string) → ResourceTypeData?

Returns the resource type data for the given resource type

GetCollectionRadius​

</>
DropletClientManager:GetCollectionRadius() → number

Gets the distance at which a droplet must be within to be collected by the LocalPlayer

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new DropletClientManager if one has not already been made,\nreturns the existing one if one already exists.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DropletClientManager"
                }
            ],
            "function_type": "static",
            "tags": [
                "constructor"
            ],
            "source": {
                "line": 87,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "RegisterResourceType",
            "desc": "Registers a new resource type.",
            "params": [
                {
                    "name": "resourceType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "ResourceTypeData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 132,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "GetResourceTypeData",
            "desc": "Returns the resource type data for the given resource type",
            "params": [
                {
                    "name": "resourceType",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ResourceTypeData?\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 141,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "GetCollectionRadius",
            "desc": "Gets the distance at which a droplet must be within to be collected by the LocalPlayer",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 149,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_Update",
            "desc": "Checks for droplets that are within the collection radius and marks\nthem as being collected as well as updates the droplet visualization",
            "params": [
                {
                    "name": "dt",
                    "desc": "",
                    "lua_type": "The delta time since the last update"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 165,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_MarkForCollection",
            "desc": "Marks a droplet to be checked for collection",
            "params": [
                {
                    "name": "droplet",
                    "desc": "",
                    "lua_type": "Droplet"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 203,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_MarkForRender",
            "desc": "Marks a droplet for rendering by placing it into the octree",
            "params": [
                {
                    "name": "droplet",
                    "desc": "",
                    "lua_type": "Droplet"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 220,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_OnCreateDroplet",
            "desc": "Called when the server informs us that a new droplet has been created",
            "params": [
                {
                    "name": "networkPacket",
                    "desc": "",
                    "lua_type": "DropletUtil.DropletNetworkPacket"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 237,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_OnClaimDroplet",
            "desc": "Called when the server informs us that a droplet has been claimed",
            "params": [
                {
                    "name": "collector",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "seed",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "dropletId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 299,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_RequestClaimDroplet",
            "desc": "Ask the server to claim the droplet so that it can be collected by the player",
            "params": [
                {
                    "name": "droplet",
                    "desc": "",
                    "lua_type": "Droplet"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 317,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        },
        {
            "name": "_RequestCollectDroplet",
            "desc": "Inform the server the client successfully collected the droplet.",
            "params": [
                {
                    "name": "droplet",
                    "desc": "",
                    "lua_type": "Droplet"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 327,
                "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DropletClientManager",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/dropletmanager/src/Client/DropletClientManager.lua"
    }
}