Skip to main content

HashRegistry

Maps animation names to compact integer hashes for MotixNet.

HashRegistry is how animation names are serialized over the network without sending full strings. Both server and client create a registry with the same names in the same order. Each name gets an integer hash based on registration order. Intents carry only the hash. 

-- SharedAnimations.lua (required by both server and client, identical order)
local Motix   = require(ReplicatedStorage.Motix)
local HashReg = Motix.MotixNet.HashRegistry.new()

HashReg:Register("Idle")    -- hash 0
HashReg:Register("Walk")    -- hash 1
HashReg:Register("Run")     -- hash 2
HashReg:Register("Fire")    -- hash 3
HashReg:Register("Reload")  -- hash 4

return HashReg
Order is everything

Hash values are assigned sequentially by registration order. If the server registers "Fire" before "Reload" and the client registers them in the opposite order, every intent involving those animations will resolve to the wrong name. Require the same shared ModuleScript on both sides and never register conditionally.

Functions​

new​

</>
HashRegistry.new() → HashRegistry

Creates a new empty HashRegistry.

local HashReg = Motix.MotixNet.HashRegistry.new()

Register​

</>
HashRegistry:Register(
name: string--

The animation name to register.

) → number--

The integer hash for this name.

Registers an animation name and returns its hash.

If the name is already registered, the existing hash is returned without creating a new entry. Hash values start at 0 and increment by 1 for each new registration. 

local hash = HashReg:Register("Idle")  -- returns 0 on first call

HashOf​

</>
HashRegistry:HashOf(
name: string--

The animation name to look up.

) → number?--

The hash, or nil if not registered.

Returns the hash for a registered animation name, or nil if not registered.

local hash = HashReg:HashOf("Fire")
if hash then
	-- use hash in a custom packet
end

NameOf​

</>
HashRegistry:NameOf(
hash: number--

The integer hash to look up.

) → string?--

The animation name, or nil.

Returns the animation name for a hash, or nil if not found.

local animName = HashReg:NameOf(3)
if animName then
	print(animName)  -- "Fire"
end

IsRegistered​

</>
HashRegistry:IsRegistered(
name: string--

The animation name to check.

) → boolean

Returns whether the given animation name is registered.

if HashReg:IsRegistered("Grenade") then
	-- safe to use in intents
end
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new empty `HashRegistry`.\n\n```lua\nlocal HashReg = Motix.MotixNet.HashRegistry.new()\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HashRegistry"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "docs/HashRegistry.lua"
            }
        },
        {
            "name": "Register",
            "desc": "Registers an animation name and returns its hash.\n\nIf the name is already registered, the existing hash is returned without creating a\nnew entry. Hash values start at `0` and increment by `1` for each new registration.\n\n```lua\nlocal hash = HashReg:Register(\"Idle\")  -- returns 0 on first call\n```",
            "params": [
                {
                    "name": "name",
                    "desc": "The animation name to register.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "The integer hash for this name.",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 58,
                "path": "docs/HashRegistry.lua"
            }
        },
        {
            "name": "HashOf",
            "desc": "Returns the hash for a registered animation name, or `nil` if not registered.\n\n```lua\nlocal hash = HashReg:HashOf(\"Fire\")\nif hash then\n\t-- use hash in a custom packet\nend\n```",
            "params": [
                {
                    "name": "name",
                    "desc": "The animation name to look up.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "The hash, or nil if not registered.",
                    "lua_type": "number?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 73,
                "path": "docs/HashRegistry.lua"
            }
        },
        {
            "name": "NameOf",
            "desc": "Returns the animation name for a hash, or `nil` if not found.\n\n```lua\nlocal animName = HashReg:NameOf(3)\nif animName then\n\tprint(animName)  -- \"Fire\"\nend\n```",
            "params": [
                {
                    "name": "hash",
                    "desc": "The integer hash to look up.",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "The animation name, or nil.",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 88,
                "path": "docs/HashRegistry.lua"
            }
        },
        {
            "name": "IsRegistered",
            "desc": "Returns whether the given animation name is registered.\n\n```lua\nif HashReg:IsRegistered(\"Grenade\") then\n\t-- safe to use in intents\nend\n```",
            "params": [
                {
                    "name": "name",
                    "desc": "The animation name to check.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 102,
                "path": "docs/HashRegistry.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HashRegistry",
    "desc": "Maps animation names to compact integer hashes for MotixNet.\n\n`HashRegistry` is how animation names are serialized over the network without sending\nfull strings. Both server and client create a registry with the same names in the same\norder. Each name gets an integer hash based on registration order. Intents carry only\nthe hash.\n\n```lua\n-- SharedAnimations.lua (required by both server and client, identical order)\nlocal Motix   = require(ReplicatedStorage.Motix)\nlocal HashReg = Motix.MotixNet.HashRegistry.new()\n\nHashReg:Register(\"Idle\")    -- hash 0\nHashReg:Register(\"Walk\")    -- hash 1\nHashReg:Register(\"Run\")     -- hash 2\nHashReg:Register(\"Fire\")    -- hash 3\nHashReg:Register(\"Reload\")  -- hash 4\n\nreturn HashReg\n```\n\n:::danger Order is everything\nHash values are assigned sequentially by registration order. If the server registers\n`\"Fire\"` before `\"Reload\"` and the client registers them in the opposite order, every\nintent involving those animations will resolve to the wrong name. Require the same shared\n`ModuleScript` on both sides and never register conditionally.\n:::",
    "source": {
        "line": 32,
        "path": "docs/HashRegistry.lua"
    }
}