Predefined function reference

get_resource

A reference entry for get_resource

Predefined function · file

get_resource()

Returns a safe path to a project resource.

Returns a safe filesystem path for a resource relative to the current source project or compiled application's resource root.

get_resource(string path) ⇒ mixed

YASS
$path = get_resource("resources/settings.json")

if ($path != undefined)
  print(file_read($path))
end if
  

The path must remain inside the active resource root. Missing resources and paths that attempt to escape that root return undefined. The function requires permission level 4.

See Compiling projects and bundling resources for the complete workflow.

Its implementation was made available in ZPE 1.14.9 (Spurriergate, September 2026).