API Reference

Global API

Application

• createPtah()
• ResourceRepository
• Runtime Instance
• Designer Instance

useRuntimeApp / useDesignerApp

• useRuntimeApp()
• useDesignerApp()

Instance in Components

• inject(PTAH_INSTANCE)
• app.$state

Utility Functions

• numberProp()
• stringProp()
• booleanProp()
• selectProp()
• objectProp()
• arrayProp()
• groupProp()

Renderers

• WebRenderer
• SceneRenderer
• FlowRenderer

Types

• MODULE_TYPE
• RESOURCE_TYPE
• LIFECYCLE_TYPE
• EVENT_TYPE
• PROPS_TYPE

Package APIs

• Open

Built-in Components

Layout

• DesignerRoot
• Preview
• FpsWidget
• WorkspaceWidget

Panel Widgets

• ModulesWidget
• ScenesWidget
• EventsWidget
• ParameterWidget

Renderer Utilities

• RendererModule