🛠️ws

Usage:

ws.{function}

This table exposes Workshop utilities.

---

GetItemID

Function

Returns current Item ID. Local scripts always return 0.

Arguments

None.

Returns

Type	Description
number	Item ID.

Example

local item_id = ws.GetItemID();

---

GetBuildID

Function

Returns current Build ID. Local scripts always return 0.

Arguments

None.

Returns

Type	Description
number	Build ID.

Example

local build_id = ws.GetBuildID();

---

GetTitle

Function

Returns current script title.

Arguments

None.

Returns

Type	Description
string	Title.

Example

local title = ws.GetTitle();

---

TestCapability

Function

Returns whether current script has a capability enabled. Available capabilities: ffi, clipboard, fs, http

Arguments

Name	Type	Description
cpb	string	Capability ID.

Returns

Type	Description
bool	True if script has the provided capability.

Example

if ws.TestCapability('clipboard') then
    utils.ClipboardSet('Hello!');
end

---

GetResourceDir

Function

Returns resource directory for this script. It is recommended to use this function only for Workshop scripts, as that is where your resources will be unpacked to.

Arguments

None.

Returns

Type	Description
string	Resource directory. Example: fatality/resource/12345

Example

local resource_dir = ws.GetResourceDir();
local tex = draw.Texture(resource_dir .. '/my_texture.png');