Yuari
Documentation
Docs/File system/getcustomasset

getcustomasset

Copies a file into Roblox's ExtraContent folder and returns an rbxasset:// URI.

Syntax

getcustomasset(path: string) -> string

Parameters

ParameterTypeDescription
pathstringA path inside the Yuari workspace.

Returns

TypeDescription
stringAn rbxasset:// URI

Description

getcustomasset is part of the File system library. File APIs are limited to the Yuari workspace under %LOCALAPPDATA%\Yuari\workspace; absolute paths and traversal outside it are rejected.

The call is read-only: it resolves the current value when invoked and does not change the underlying state.

The aliases getsynasset(path), getrbxasset(path) resolve to the same implementation.

Example

print(getcustomasset("images/logo.png"))
print(getsynasset("images/logo.png"))
print(getrbxasset("images/logo.png"))

Notes

  • Aliases: getsynasset(path), getrbxasset(path).
  • All paths are confined to %LOCALAPPDATA%\Yuari\workspace.