UIPages
Defined in: sdk/src/ui/pages/ui-pages.ts:70
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIPages(
world_,assets_):UIPages
Defined in: sdk/src/ui/pages/ui-pages.ts:76
Parameters
Section titled “Parameters”world_
Section titled “world_”assets_
Section titled “assets_”Assets
Returns
Section titled “Returns”UIPages
Methods
Section titled “Methods”close()
Section titled “close()”close(
id):void
Defined in: sdk/src/ui/pages/ui-pages.ts:143
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
has(
id):boolean
Defined in: sdk/src/ui/pages/ui-pages.ts:84
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
isBuilt()
Section titled “isBuilt()”isBuilt(
id):boolean
Defined in: sdk/src/ui/pages/ui-pages.ts:113
Whether the page has been built (and not destroyed since).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
isOpen()
Section titled “isOpen()”isOpen(
id):boolean
Defined in: sdk/src/ui/pages/ui-pages.ts:116
Whether the page is open: built and switched on.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
onBuilt()
Section titled “onBuilt()”onBuilt(
listener): () =>void
Defined in: sdk/src/ui/pages/ui-pages.ts:122
Called each time a page is built, after its contents exist and before the open that asked for it answers: the place to wire it.
Parameters
Section titled “Parameters”listener
Section titled “listener”(page) => void
Returns
Section titled “Returns”() => void
open()
Section titled “open()”open(
id):Promise<PageHandle>
Defined in: sdk/src/ui/pages/ui-pages.ts:132
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<PageHandle>
page()
Section titled “page()”page(
id):PageHandle|null
Defined in: sdk/src/ui/pages/ui-pages.ts:119
The page’s handle, once it has been built.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PageHandle | null
preload()
Section titled “preload()”preload(
id):Promise<void>
Defined in: sdk/src/ui/pages/ui-pages.ts:128
Fetch the page’s prefab now, so that building it later is only making entities.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
register()
Section titled “register()”register(
id,def):void
Defined in: sdk/src/ui/pages/ui-pages.ts:78
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
registerDeferred()
Section titled “registerDeferred()”registerDeferred(
entity,onClose?):string|null
Defined in: sdk/src/ui/pages/ui-pages.ts:91
Register a virtual instance of the scene (prefab/deferred.ts) as a page named after its root: the root is the mount, and the prefab and overrides are the ones the instance was made from. Answers the page’s id, or null when the entity is not a virtual instance or is already registered.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
onClose?
Section titled “onClose?”"destroy" | "keep" | undefined = 'keep'
Returns
Section titled “Returns”string | null
registerDeferredAll()
Section titled “registerDeferredAll()”registerDeferredAll(
root?,onClose?):string[]
Defined in: sdk/src/ui/pages/ui-pages.ts:102
Register every virtual instance of the world — or only those under root — that is not a page yet. Answers their ids.
Parameters
Section titled “Parameters”number
onClose?
Section titled “onClose?”"destroy" | "keep" | undefined = 'keep'
Returns
Section titled “Returns”string[]