Skip to content

UI builder - Studio API

Engine

To execute Engine APIs, take a look at the examples below:

Examples:

Api.engine("My Engine").cache("My Asset");
Api.engine("My Engine").clear();

sendCommand

Send Command to the Engine

Api.engine("My Engine").sendCommand(command: object | string): void;

Parameter Type Description
command object/string The command to be sent to the Engine

clear

Clear the Engine

Api.engine("My Engine").clear(layer?: string): void;

Parameter Type Description
layer string The Layer to be cleared

cleanup

Cleanup the Engine

Api.engine("My Engine").cleanup(): void;

cache

Cache the Asset/Assets in the path

Api.engine("My Engine").cache(asset: string): void;
Parameter Type Description
asset string/string[ ] The Asset/Assets to be cached