Skip to main content

DropletServerManager

Functions​

RegisterResourceType​

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

Registers a new resource type. Attempting to register a resource type with the same name as an existing one will error. Resource types define how droplets of that type behave on the server and client. The same table must be registered to the same name on both server and client. 

local data = require(path.to.ExampleResourceTypeData) -- There is an Example file included in the package you can check out.
DropletServerManager:RegisterResourceType("Example", data)

GetResourceTypeData​

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

Returns the data that was provided for a given registered resource type.

Spawn​

</>
DropletServerManager:Spawn(
data: ResourceSpawnData--

The data used to spawn the droplet.

) → number--

The seed of the droplet request.

Creates a new droplet request to create some defined number of droplets of a given ResourceType. The droplet request will be created on the server and replicated to the clients.

A PlayerTargets array can be passed to specify which players the droplet request should be replicated to, if one isnt given it replicates to all connected players at the moment of the request.

Caveats

Some properties of the interface have special behaviors depending on their type. See 'ResourceSpawnData' for more info on important caveats and behavior. 

local Bounds = 35

local seed = DropletServerManager:Spawn({
    ResourceType = "Example";
    Value = NumberRange.new(0.6, 1.4);
    Count = NumberRange.new(2, 10);
    LifeTime = NumberRange.new(10, 20);
    SpawnLocation = Vector3.new(
        math.random(-Bounds,Bounds),
        7,
        math.random(-Bounds,Bounds)
    );
    CollectorMode = "MultiCollector";
})

Claim​

</>
DropletServerManager:Claim(
collector: Player,--

The player claiming the droplet.

seed: number,--

The droplet request identifier.

dropletNumber: number?--

The particular droplet number to claim. If nil, all remaining droplets will be claimed.

) → boolean--

Whether or not the claim was successful.

Force claim a droplet(s) for a player.

Collect​

</>
DropletServerManager:Collect(
collector: Player,--

The player collecting the resource.

seed: number,--

The droplet request identifier.

dropletNumber: number?--

The particular droplet number to collect. If nil, all droplets will be collected.

) → boolean--

Whether or not the collection was successful.

Force collects a droplet(s) resource and returns whether or not the collection was successful.

Show raw api
{
    "functions": [
        {
            "name": "RegisterResourceType",
            "desc": "Registers a new resource type. Attempting to register a resource type with the same name as an existing one will error.\nResource types define how droplets of that type behave on the server and client.\nThe same table must be registered to the same name on both server and client.\n```lua\nlocal data = require(path.to.ExampleResourceTypeData) -- There is an Example file included in the package you can check out.\nDropletServerManager:RegisterResourceType(\"Example\", data)\n```",
            "params": [
                {
                    "name": "resourceType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "ResourceTypeData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 129,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "GetResourceTypeData",
            "desc": "Returns the data that was provided for a given registered resource type.",
            "params": [
                {
                    "name": "resourceType",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ResourceTypeData?\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 137,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "Spawn",
            "desc": "Creates a new droplet request to create some defined number of droplets of a given ResourceType.\nThe droplet request will be created on the server and replicated to the clients.\n\nA PlayerTargets array can be passed to specify which players the droplet request should be replicated to,\nif one isnt given it replicates to all connected players at the moment of the request.\n\n:::caution Caveats\nSome properties of the interface have special behaviors depending on their type.\nSee 'ResourceSpawnData' for more info on important caveats and behavior.\n:::\n\n```lua\nlocal Bounds = 35\n\nlocal seed = DropletServerManager:Spawn({\n    ResourceType = \"Example\";\n    Value = NumberRange.new(0.6, 1.4);\n    Count = NumberRange.new(2, 10);\n    LifeTime = NumberRange.new(10, 20);\n    SpawnLocation = Vector3.new(\n        math.random(-Bounds,Bounds),\n        7,\n        math.random(-Bounds,Bounds)\n    );\n    CollectorMode = \"MultiCollector\";\n})\n```",
            "params": [
                {
                    "name": "data",
                    "desc": "The data used to spawn the droplet.",
                    "lua_type": "ResourceSpawnData"
                }
            ],
            "returns": [
                {
                    "desc": "The seed of the droplet request.",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 173,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "Claim",
            "desc": "Force claim a droplet(s) for a player.",
            "params": [
                {
                    "name": "collector",
                    "desc": "The player claiming the droplet.",
                    "lua_type": "Player"
                },
                {
                    "name": "seed",
                    "desc": "The droplet request identifier.",
                    "lua_type": "number"
                },
                {
                    "name": "dropletNumber",
                    "desc": "The particular droplet number to claim. If nil, all remaining droplets will be claimed.",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "Whether or not the claim was successful.",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 257,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "Collect",
            "desc": "Force collects a droplet(s) resource and returns whether or not the collection was successful.",
            "params": [
                {
                    "name": "collector",
                    "desc": "The player collecting the resource.",
                    "lua_type": "Player"
                },
                {
                    "name": "seed",
                    "desc": "The droplet request identifier.",
                    "lua_type": "number"
                },
                {
                    "name": "dropletNumber",
                    "desc": "The particular droplet number to collect. If nil, all droplets will be collected.",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "Whether or not the collection was successful.",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 326,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "_GenerateSeed",
            "desc": "Generates a new unused seed",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 408,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        },
        {
            "name": "_GetDropletServerData",
            "desc": "Returns the droplet server data for the given seed.",
            "params": [
                {
                    "name": "seed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DropletUtil.DropletServerCacheData?\n"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 420,
                "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DropletServerManager",
    "desc": "",
    "source": {
        "line": 6,
        "path": "lib/dropletmanager/src/Server/DropletServerManager.luau"
    }
}