Skip to main content

PositionDataHasher

Hashes a data table based on the "position", a number value, each data is at

Properties​

positionData​

</>
PositionDataHasher.positionData: {T}

length​

</>
PositionDataHasher.length: number

hashData​

</>
PositionDataHasher.hashData: {number}--indexoftheclosestdataateachhashinterval

hashInterval​

</>
PositionDataHasher.hashInterval: number

getPositionFunction​

</>
PositionDataHasher.getPositionFunction: (
a: T,
b: T
) → number

Functions​

new​

Constructor
</>
PositionDataHasher.new() → PositionDataHasher

Creates a new PositionDataHasher

create​

Constructor
</>
PositionDataHasher.create(
positionData: {T},
getPositionFunction: (
a: T,
b: T
) → number,
hashInterval: number?--

default is 10

) → PositionDataHasher

Destroy​

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

_setData​

</>
PositionDataHasher:_setData(
positionData: {T},
getPositionFunction: (
a: T,
b: T
) → number,
hashInterval: number
) → ()

Sets the data

getData​

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

Data 1

T,--

Data 2

number
)

Gets the Data

Errors

TypeDescription
"positionData is empty!" - Shouldn't really happen
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new PositionDataHasher",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PositionDataHasher"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 25,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "create",
            "desc": "",
            "params": [
                {
                    "name": "positionData",
                    "desc": "",
                    "lua_type": "{T}"
                },
                {
                    "name": "getPositionFunction",
                    "desc": "",
                    "lua_type": "(a: T, b: T) -> number"
                },
                {
                    "name": "hashInterval",
                    "desc": "default is `10`",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PositionDataHasher"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 46,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 59,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "_setData",
            "desc": "Sets the data",
            "params": [
                {
                    "name": "positionData",
                    "desc": "",
                    "lua_type": "{T}"
                },
                {
                    "name": "getPositionFunction",
                    "desc": "",
                    "lua_type": "(a: T, b: T) -> number"
                },
                {
                    "name": "hashInterval",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.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": "\"positionData is empty!\" - Shouldn't really happen",
                    "desc": ""
                }
            ],
            "source": {
                "line": 143,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "positionData",
            "desc": "",
            "lua_type": "{T}",
            "source": {
                "line": 6,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "length",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 9,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "hashData",
            "desc": "",
            "lua_type": "{number} -- index of the closest data at each hash interval",
            "source": {
                "line": 12,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "hashInterval",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 15,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        },
        {
            "name": "getPositionFunction",
            "desc": "",
            "lua_type": "(a: T, b: T) -> number",
            "source": {
                "line": 18,
                "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
            }
        }
    ],
    "types": [],
    "name": "PositionDataHasher",
    "desc": "Hashes a data table based on the \"position\", a number value, each data is at",
    "source": {
        "line": 3,
        "path": "src/shared/cframeTrack/util/PositionDataHasher.lua"
    }
}