Skip to main content

TrackDataHasher

Hashes a track data table based on the track length between data HashInterval is the lengths

Properties​

trackData​

</>
TrackDataHasher.trackData: {T}

length​

</>
TrackDataHasher.length: number

hashData​

</>
TrackDataHasher.hashData: {(
number,
number
)}--index,trackLength

hashInterval​

</>
TrackDataHasher.hashInterval: number

getLengthFunction​

</>
TrackDataHasher.getLengthFunction: (
a: T,
b: T
) → number

Functions​

new​

Constructor
</>
TrackDataHasher.new() → TrackDataHasher

Creates a new TrackDataHasher

create​

Constructor
</>
TrackDataHasher.create(
trackData: {T},
getLengthFunction: (
a: T,
b: T
) → number,
hashInterval: number?--

default is 10

) → TrackDataHasher

Destroy​

Deconstructor
</>
TrackDataHasher:Destroy() → ()

_setData​

</>
TrackDataHasher:_setData(
trackData: {T},
getLengthFunction: (
a: T,
b: T
) → number,
hashInterval: number
) → ()

Sets the data

getData​

</>
TrackDataHasher:getData(position: number) → (
T,--

Data 1

T,--

Data 2

number
)

Gets the Data

Errors

TypeDescription
"trackData is empty!" - Shouldn't really happen
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new TrackDataHasher",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrackDataHasher"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 26,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "create",
            "desc": "",
            "params": [
                {
                    "name": "trackData",
                    "desc": "",
                    "lua_type": "{T}"
                },
                {
                    "name": "getLengthFunction",
                    "desc": "",
                    "lua_type": "(a: T, b: T) -> number"
                },
                {
                    "name": "hashInterval",
                    "desc": "default is `10`",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrackDataHasher"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 47,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 60,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "_setData",
            "desc": "Sets the data",
            "params": [
                {
                    "name": "trackData",
                    "desc": "",
                    "lua_type": "{T}"
                },
                {
                    "name": "getLengthFunction",
                    "desc": "",
                    "lua_type": "(a: T, b: T) -> number"
                },
                {
                    "name": "hashInterval",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 71,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "getData",
            "desc": "Gets the Data",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Data 1",
                    "lua_type": "T"
                },
                {
                    "desc": "Data 2",
                    "lua_type": "T"
                },
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "\"trackData is empty!\" - Shouldn't really happen",
                    "desc": ""
                }
            ],
            "source": {
                "line": 131,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "trackData",
            "desc": "",
            "lua_type": "{T}",
            "source": {
                "line": 7,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "length",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 10,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "hashData",
            "desc": "",
            "lua_type": "{(number, number)} -- index, trackLength",
            "source": {
                "line": 13,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "hashInterval",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 16,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        },
        {
            "name": "getLengthFunction",
            "desc": "",
            "lua_type": "(a: T, b: T) -> number",
            "source": {
                "line": 19,
                "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
            }
        }
    ],
    "types": [],
    "name": "TrackDataHasher",
    "desc": "Hashes a track data table based on the track length between data\nHashInterval is the lengths",
    "source": {
        "line": 4,
        "path": "src/shared/cframeTrack/util/TrackDataHasher.lua"
    }
}