Skip to main content

Bezier

The class used to construct Bézier curves.

Functions

new

Bezier.new(
points{Vector3}--

The array of points

) → BezierCurve

Constructs a new BezierCurve from an array of points. Obviously, you should use two or more points.

fromParts

Bezier.fromParts(
folderInstance--

The instance that has the Parts as children

) → BezierCurve

Constructs a new BezierCurve from a folder with Parts. The parts must have a number as their name (1, 2, 3, ...) so the order of the points is clear.

random

Bezier.random(
startCFrame | Vector3,--

The first point

pointsnumber,--

The amount of points

distanceBetweenPointsNumberRange,--

The approximate distance between points

variationnumber?--

The smaller the variation, the more it will look like a straight line

) → BezierCurve

Constructs a random BezierCurve. If start is a CFrame, the curve will go in its LookVector's direction, otherwise in a random direction.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new [BezierCurve] from an array of points.\nObviously, you should use two or more points.",
            "params": [
                {
                    "name": "points",
                    "desc": "The array of points",
                    "lua_type": "{Vector3}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BezierCurve"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/Bezier.lua"
            }
        },
        {
            "name": "fromParts",
            "desc": "Constructs a new [BezierCurve] from a folder with Parts.\nThe parts must have a number as their name (1, 2, 3, ...) so the order of the points is clear.",
            "params": [
                {
                    "name": "folder",
                    "desc": "The instance that has the Parts as children",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BezierCurve"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 89,
                "path": "src/Bezier.lua"
            }
        },
        {
            "name": "random",
            "desc": "Constructs a random [BezierCurve].\nIf `start` is a CFrame, the curve will go in its LookVector's direction, otherwise in a random direction.",
            "params": [
                {
                    "name": "start",
                    "desc": "The first point",
                    "lua_type": "CFrame | Vector3"
                },
                {
                    "name": "points",
                    "desc": "The amount of points",
                    "lua_type": "number"
                },
                {
                    "name": "distanceBetweenPoints",
                    "desc": "The approximate distance between points",
                    "lua_type": "NumberRange"
                },
                {
                    "name": "variation",
                    "desc": "The smaller the variation, the more it will look like a straight line",
                    "lua_type": "number?\r\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BezierCurve"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 111,
                "path": "src/Bezier.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Bezier",
    "desc": "The class used to construct Bézier curves.",
    "source": {
        "line": 29,
        "path": "src/Bezier.lua"
    }
}