๐Ÿ› ๏ธws

Usage:

ws.{function}

This table exposes Workshop utilities.


get_item_id

Function

Returns current Item ID. Local scripts always return 0.

Arguments

None.

Returns

Type
Description

number

Item ID.

Example

local item_id = ws.get_item_id();

get_build_id

Function

Returns current Build ID. Local scripts always return 0.

Arguments

None.

Returns

Type
Description

number

Build ID.

Example

local build_id = ws.get_build_id();

get_title

Function

Returns current script title.

Arguments

None.

Returns

Type
Description

string

Title.

Example

local title = ws.get_title();

test_capability

Function

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

Arguments

Name
Type
Description

cpb

string

Capability ID.

Returns

Type
Description

bool

True if script has the provided capability.

Example

if ws.test_capability('clipboard') then
    utils.clipboard_set('Hello!');
end

get_resource_dir

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.get_resource_dir();
local tex = draw.texture(resource_dir . '/my_texture.png');

Last updated