util.file.hash

Shared

Retrieves the hash of a specified file


Syntax

local hash = util.file.hash(
    path,
    mode
)

Prefix the path with :resourcename to access files from another running resource.

  • Local path — resolves relative to the current resource's directory.
  • Cross-resource path — prefix with :resourcename to resolve relative to another running resource's directory.
  • Example:resource_a/files/images/test.png accesses files/images/test.png inside resource_a.

Parameters

TypeNameDescription
stringpathFile path to hash
stringmodeHashing algorithm to use - same modes as used in util.crypto.hash

Returns

TypeNameDescription
string | boolhashComputed file hash on successful execution, false otherwise

Examples

Hash a file within the current resource
core.engine.print("info", "File hash:", util.file.hash("files/images/test.png", "sha256"))
Hash a file from another running resource
core.engine.print("info", "File hash:", util.file.hash(":resource_a/files/images/test.png", "sha256"))

On this page