Skip to main content

VolumeArrow

Renders an arrow with a ConeHandleAdornment instead of a wireframe cone.

Functions​

Draw​

</>
VolumeArrow.Draw(
Origin: Vector3,
End: Vector3,
CylinderRadius: number,
ConeRadius: number,
Length: number,
UseCylinder: boolean?
) → ()

Create​

</>
VolumeArrow.Create(
Origin: Vector3,
End: Vector3,
CylinderRadius: number,
ConeRadius: number,
Length: number,
UseCylinder: boolean?
) → {
Origin: Vector3,
End: Vector3,
CylinderRadius: number,
ConeRadius: number,
Length: number,
UseCylinder: boolean?,
Color3: Color3,
AlwaysOnTop: boolean,
Transparency: number,
Enabled: boolean,
Destroy: boolean
}
Show raw api
{
    "functions": [
        {
            "name": "Draw",
            "desc": "",
            "params": [
                {
                    "name": "Origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "End",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "CylinderRadius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "ConeRadius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "Length",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "UseCylinder",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/CeiveImGizmo/Gizmos/VolumeArrow.luau"
            }
        },
        {
            "name": "Create",
            "desc": "",
            "params": [
                {
                    "name": "Origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "End",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "CylinderRadius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "ConeRadius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "Length",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "UseCylinder",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Origin: Vector3, End: Vector3, CylinderRadius: number, ConeRadius: number, Length: number,  UseCylinder: boolean?, Color3: Color3, AlwaysOnTop: boolean, Transparency: number, Enabled: boolean, Destroy: boolean}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/CeiveImGizmo/Gizmos/VolumeArrow.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "VolumeArrow",
    "desc": "Renders an arrow with a ConeHandleAdornment instead of a wireframe cone.\r",
    "source": {
        "line": 3,
        "path": "src/CeiveImGizmo/Gizmos/VolumeArrow.luau"
    }
}