[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.Hash


Name Hash
Type Method
Summary Produces a hash (checksum) of a specified piece of text
Prototype BSTR Hash(BSTR Text);

View list of 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.


Note: Available in version 3.23 onwards.


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.
Returns A 40-character hexadecimal string which is the hash of the supplied text.
Introduced in version 3.23

See also ...

Function Description
GetUniqueID Creates a unique ID for general use, or for making Plugin IDs

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]