Skip to main content

CFrameSerializer

Optimized these functions for speed as well as preserving fidality. In the future, use Roblox's orthogonal angle format.

Functions​

outputRotationAzure​

</>
CFrameSerializer.outputRotationAzure(cf: CFrame) → {
number,
number,
number,
number,
number,
number
}

Outputs the rotation

toJSONString​

</>
CFrameSerializer.toJSONString(cf: CFrame) → string

Encodes a CFrame into JSON for serialization in attributes.

isRotationAzure​

</>
CFrameSerializer.isRotationAzure(data: any) → boolean

Returnst true if it's a table encoded cframe

fromJSONString​

</>
CFrameSerializer.fromJSONString(str: string) → CFrame

Decodes a CFrame from JSON. For serialization in attributes.

readPosition​

</>
CFrameSerializer.readPosition(data: {
number,
number,
number,
number,
number,
number
}) → Vector3

Returns the position

readRotationAzure​

</>
CFrameSerializer.readRotationAzure(data: {
number,
number,
number,
number,
number,
number
}) → Vector3

Returns the CFrame

Show raw api
{
    "functions": [
        {
            "name": "outputRotationAzure",
            "desc": "Outputs the rotation",
            "params": [
                {
                    "name": "cf",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ number, number, number, number, number, number }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        },
        {
            "name": "toJSONString",
            "desc": "Encodes a CFrame into JSON for serialization in attributes.",
            "params": [
                {
                    "name": "cf",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        },
        {
            "name": "isRotationAzure",
            "desc": "Returnst true if it's a table encoded cframe",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 65,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        },
        {
            "name": "fromJSONString",
            "desc": "Decodes a CFrame from JSON. For serialization in attributes.",
            "params": [
                {
                    "name": "str",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        },
        {
            "name": "readPosition",
            "desc": "Returns the position",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "{ number, number, number, number, number, number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        },
        {
            "name": "readRotationAzure",
            "desc": "Returns the CFrame",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "{ number, number, number, number, number, number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CFrameSerializer",
    "desc": "Optimized these functions for speed as well as preserving fidality.\nIn the future, use Roblox's orthogonal angle format.",
    "source": {
        "line": 7,
        "path": "src/cframeserializer/src/Shared/CFrameSerializer.lua"
    }
}