world.Hash

MUSHclient script function (Method) — introduced in version 3.23

Produces a hash (checksum) of a specified piece of text

Prototype

BSTR Hash(BSTR Text);

Data type meanings

Description

This produces a 160-bit hash of the supplied text, returned as a 40-character hex string (40 X 4 bits = 160 bits). eg.

world.note world.hash ("This Mud is running on the Dawn Codebase")

c6a948fc8e81baa172a15aa534409b7654861a33

You might use this to store a hash of a long string (eg. a script file) to see if it has changed rather than storing the text itself.

There is no limit to the length of the string that can be hashed.

Because of the way strings are stored this will not work with strings which have nulls in them (hex 00), however see below for a work-around for Lua.

VBscript example

world.note world.hash ("This Mud is running on the Dawn Codebase")

Jscript example

world.note (world.hash ("This Mud is running on the Dawn Codebase"));

PerlScript example

$world->note ($world->hash ("This Mud is running on the Dawn Codebase"));

Python example

world.note (world.hash ("This Mud is running on the Dawn Codebase"))

Lua example

Note (Hash("This Mud is running on the Dawn Codebase"))

Lua notes

In MUSHclient version 3.57 onwards you can also use

hashed_string = utils.hash (s)

This works the same as described above, however it will correctly handle strings with the null (hex 00) character in them.

Return value

A 40-character hexadecimal string which is the hash of the supplied text.

Related topic

Utilities

See also