Skip to main content

Droplet

Types​

Droplet​

</>
type Droplet = Droplet

Functions​

GetValue​

</>
Droplet:GetValue() → any

GetMetadata​

</>
Droplet:GetMetadata() → any?

GetResourceTypeData​

</>
Droplet:GetResourceTypeData() → ResourceTypeData

GetPosition​

</>
Droplet:GetPosition() → Vector3

GetModel​

</>
Droplet:GetModel() → Actor

GetSetupData​

</>
Droplet:GetSetupData() → any

Returns the data that was returned by the ResourceTypeData.Setup function

Identify​

</>
Droplet:Identify() → (
number,--

The seed of the droplet

number--

The id of the droplet

)

Returns the seed and id of the droplet. Used for internal identification.

IsTimingOut​

</>
Droplet:IsTimingOut() → boolean

Returns whether or not the droplet is in the process of timing out.

AttachModel​

</>
Droplet:AttachModel(object: Model | BasePart) → ()

Attaches a Model or Part to the droplet. Use this to add your visuals to the droplet.

Collect​

</>
Droplet:Collect(playerWhoCollected: Player) → ()

Claim​

</>
Droplet:Claim(playerWhoClaimed: Player) → ()
Show raw api
{
    "functions": [
        {
            "name": "processRendering",
            "desc": "Called by DropletClientManager",
            "params": [],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 142,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new Droplet instance. Called by DropletClientManager.",
            "params": [
                {
                    "name": "config",
                    "desc": "The configuration for the droplet.",
                    "lua_type": "{\n    Id: number;\n    NetworkPacket: DropletUtil.DropletNetworkPacket;\n    ResourceTypeData: DropletUtil.ResourceTypeData;\n\n    Value: any?,\n    LifeTime: number,\n}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Droplet"
                }
            ],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 155,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetValue",
            "desc": "    ",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 243,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetMetadata",
            "desc": "    ",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any?\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 250,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetResourceTypeData",
            "desc": "    ",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ResourceTypeData\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 257,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetPosition",
            "desc": "    ",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 264,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetPivot",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame\n"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 271,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetModel",
            "desc": "    ",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Actor\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 278,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "GetSetupData",
            "desc": "Returns the data that was returned by the ResourceTypeData.Setup function",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 286,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "Identify",
            "desc": "Returns the seed and id of the droplet. Used for internal identification.",
            "params": [],
            "returns": [
                {
                    "desc": "The seed of the droplet",
                    "lua_type": "number"
                },
                {
                    "desc": "The id of the droplet",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 295,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "IsTimingOut",
            "desc": "Returns whether or not the droplet is in the process of timing out.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 302,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "AttachModel",
            "desc": "Attaches a Model or Part to the droplet. Use this to add your visuals to the droplet.",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "Model | BasePart"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 314,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "Collect",
            "desc": "    ",
            "params": [
                {
                    "name": "playerWhoCollected",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 337,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "Claim",
            "desc": "    ",
            "params": [
                {
                    "name": "playerWhoClaimed",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 353,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "Magnetize",
            "desc": "",
            "params": [
                {
                    "name": "playerWhoCollected",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 366,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        },
        {
            "name": "_Render",
            "desc": "",
            "params": [
                {
                    "name": "dt",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 472,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "Droplet",
            "desc": "",
            "lua_type": "Droplet",
            "source": {
                "line": 488,
                "path": "src/dropletmanager/src/Client/Droplet.lua"
            }
        }
    ],
    "name": "Droplet",
    "desc": "",
    "source": {
        "line": 6,
        "path": "src/dropletmanager/src/Client/Droplet.lua"
    }
}