Skip to main content

QFrame

CFrame representation as a quaternion. Alternative representation of a CFrame.

Functions​

new​

</>
QFrame.new(
x: number?,
y: number?,
z: number?,
W: number?,
X: number?,
Y: number?,
Z: number?
) → QFrame

Constructs a new QFrame

isQFrame​

</>
QFrame.isQFrame(value: any) → boolean

Returns whether a value is a QFrame

fromCFrameClosestTo​

</>
QFrame.fromCFrameClosestTo(
cframe: CFrame,
closestTo: QFrame
) → QFrame

Gets the QFrame closest to that CFrame

fromVector3​

</>
QFrame.fromVector3(
vector: Vector3,
qFrame: QFrame
) → QFrame

Constructs a QFrame from a position and another QFrame rotation.

toCFrame​

</>
QFrame.toCFrame(self: QFrame) → CFrame?

Converts the QFrame to a CFrame

toPosition​

</>
QFrame.toPosition(self: QFrame) → Vector3

Converts the QFrame to a Vector3 position

isNAN​

</>
QFrame.isNAN(a: QFrame) → boolean

Returns true if the QFrame contains a NaN value.

__unm​

</>
QFrame.__unm(a: QFrame) → QFrame

Inverts the QFrame

__add​

</>
QFrame.__add(
a: QFrame,
b: QFrame
) → QFrame

Adds the QFrames together

__sub​

</>
QFrame.__sub(
a: QFrame,
b: QFrame
) → QFrame

Subtracts the QFrames together

__pow​

</>
QFrame.__pow(
a: QFrame,
b: number
) → QFrame

Takes the QFrame to the power, using quaternion power formula.

__mul​

</>
QFrame.__mul(
a: QFrame | number,
b: QFrame | number
) → QFrame

Multiplies the QFrames together

__div​

</>
QFrame.__div(
a: QFrame,
b: number
) → QFrame

Divides the QFrame by the number

__eq​

</>
QFrame.__eq(
a: QFrame,
b: QFrame
) → boolean

Compares the QFrame for equality.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new QFrame",
            "params": [
                {
                    "name": "x",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "y",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "z",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "W",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "X",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "Y",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "Z",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "isQFrame",
            "desc": "Returns whether a value is a QFrame",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "fromCFrameClosestTo",
            "desc": "Gets the QFrame closest to that CFrame",
            "params": [
                {
                    "name": "cframe",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "closestTo",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "fromVector3",
            "desc": "Constructs a QFrame from a position and another QFrame rotation.",
            "params": [
                {
                    "name": "vector",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "qFrame",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "toCFrame",
            "desc": "Converts the QFrame to a [CFrame]",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "toPosition",
            "desc": "Converts the QFrame to a [Vector3] position",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "isNAN",
            "desc": "Returns true if the QFrame contains a NaN value.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 116,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__unm",
            "desc": "Inverts the QFrame",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__add",
            "desc": "Adds the QFrames together",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 135,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__sub",
            "desc": "Subtracts the QFrames together",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__pow",
            "desc": "Takes the QFrame to the power, using quaternion power formula.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 159,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__mul",
            "desc": "Multiplies the QFrames together",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame | number"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "QFrame | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 212,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__div",
            "desc": "Divides the QFrame by the number",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 243,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        },
        {
            "name": "__eq",
            "desc": "Compares the QFrame for equality.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "QFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 257,
                "path": "src/qframe/src/Shared/QFrame.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "QFrame",
    "desc": "CFrame representation as a quaternion. Alternative representation of a [CFrame].",
    "source": {
        "line": 6,
        "path": "src/qframe/src/Shared/QFrame.lua"
    }
}