Skip to main content

Host Overview

The Host namespace is the top-level entry point for all host services — command execution, dialog management, object access, engine services, file I/O, signals, and more.

Properties

PropertyTypeWritableExampleDescription
ClassesobjectNoHost.Classes.createInstance(id)Class factory and inspection
ConsoleobjectNoHost.Console.writeLine(text)Console output for debugging
EngineobjectNoHost.Engine.TrackFormatsTrack format, color, speaker, and formatter helpers
GUIobjectNoHost.GUI.Commands.interpretCommand(...)Command execution, dialogs, clipboard, themes, URL handling
InterfacesobjectNoHost.Interfaces.IEditTaskInterface capability markers for this.interfaces
IOobjectNoHost.IO.openTextFile(path)File read/write, JSON, XML, Base64
ObjectsobjectNoHost.Objects.getObjectByUrl(url)URL-based host object access
ResultsobjectNoHost.Results.kResultOkStandard result code constants
ServicesobjectNoHost.Services.getInstance(id)Service locator for inter-script singleton access
SettingsobjectNoHost.Settings.getAttributes()Script-local key-value persistence between phases
SignalsobjectNoHost.Signals.signal(ch, name, payload)Pub/sub messaging between scripts
SystemInfoobjectNoHost.SystemInfo.getLocalTime()System time access
studioappobjectNoHost.studioapp.interpretCommand(...)Root URL object, same as ://hostapp

Methods

MethodReturnsParametersDescription
Host.Attributes(array)objectarray — flat key-value array (["key", "val", ...])Wrap a key-value array into an Attributes object
Host.DateTime(date)objectdate — date string (e.g. "2026/01/01")Parse a date string into a DateTime object
Host.Url(path)objectpath — URL string (e.g. "local://$USERCONTENT/...")Construct a URL path object
Host.getPlatform()stringnoneDetect current platform ("win" or "mac")
Host.sleep(ms)ms — milliseconds to sleepSleep for a given duration