• Preparing search index...
  • The search index is not available
SDK Documentation - v7.0.0
  • SDK Documentation - v7.0.0
  • sdk/src/explorer-ui
  • openExplorerUiAndWait

Function openExplorerUiAndWait

  • openExplorerUiAndWait<const C>(request: OpenExplorerUiRequest, options?: WaitOptions<C>): Promise<WaitOutcome<C>>
  • Opens an explorer panel and waits for the session it started. The wait ends when the panel closes. See WaitOptions to collect events, to stop earlier or to bound the wait.

    Every lifecycle outcome resolves, see WaitOutcome. The promise rejects only when an event cannot be attributed to a call at all: an explorer too old to echo request_id paired with a panel that can coexist with another one.

    Type Parameters

    • const C extends readonly AnyChannel[] = []

    Parameters

    • request: OpenExplorerUiRequest
    • Optional options: WaitOptions<C>

    Returns Promise<WaitOutcome<C>>

    • Defined in sdk/src/explorer-ui/index.ts:131
  • openExplorerUiAndWait(ui: EU_SETTINGS | EU_MAP | EU_BACKPACK | EU_CAMERA_REEL | EU_COMMUNITIES | EU_PLACES | EU_EVENTS): Promise<WaitOutcome<[]>>
  • Opens an explorer panel and waits for the session it started. The wait ends when the panel closes. See WaitOptions to collect events, to stop earlier or to bound the wait.

    Every lifecycle outcome resolves, see WaitOutcome. The promise rejects only when an event cannot be attributed to a call at all: an explorer too old to echo request_id paired with a panel that can coexist with another one.

    Parameters

    • ui: EU_SETTINGS | EU_MAP | EU_BACKPACK | EU_CAMERA_REEL | EU_COMMUNITIES | EU_PLACES | EU_EVENTS

    Returns Promise<WaitOutcome<[]>>

    • Defined in sdk/src/explorer-ui/index.ts:135
Documentation

Settings

Member Visibility

Theme

Modules

  • SDK Documentation - v7.0.0
    • ECS
      • AppendValueOperation
      • AvatarTexture
      • BorderRect
      • CameraTransition
      • ColorRange
      • ComponentData
      • Composite
      • CompositeComponent
      • CompositeComponent_DataEntry
      • CompositeDefinition
      • CrdtMessageProtocol
      • DeleteComponent
      • DeleteComponentNetwork
      • DeleteEntity
      • DeleteEntityNetwork
      • EntityUtils
      • FloatRange
      • Move
      • MoveContinuous
      • MoveRotateScale
      • PBAnimationState
      • PBAnimator
      • PBAssetLoad
      • PBAssetLoadLoadingState
      • PBAudioAnalysis
      • PBAudioEvent
      • PBAudioSource
      • PBAudioStream
      • PBAvatarAttach
      • PBAvatarBase
      • PBAvatarEmoteCommand
      • PBAvatarEquippedData
      • PBAvatarLocomotionSettings
      • PBAvatarModifierArea
      • PBAvatarNametag
      • PBAvatarShape
      • PBBillboard
      • PBCameraMode
      • PBCameraModeArea
      • PBColor3
      • PBColor4
      • PBEngineInfo
      • PBExplorerItemPurchaseResult
      • PBExplorerItemPurchaseResult_Dismissed
      • PBExplorerItemPurchaseResult_Failed
      • PBExplorerItemPurchaseResult_Purchased
      • PBExplorerUiEventsResult
      • PBExplorerUiEventsResult_UiClosed
      • PBExplorerUiEventsResult_UiOpened
      • PBGltfContainer
      • PBGltfContainerLoadingState
      • PBGltfNodeModifiers
      • PBGltfNodeModifiers_GltfNodeModifier
      • PBInputModifier
      • PBInputModifier_StandardInput
      • PBLightSource
      • PBLightSource_Point
      • PBLightSource_Spot
      • PBMainCamera
      • PBMaterial
      • PBMaterial_PbrMaterial
      • PBMaterial_UnlitMaterial
      • PBMeshCollider
      • PBMeshCollider_BoxMesh
      • PBMeshCollider_CylinderMesh
      • PBMeshCollider_PlaneMesh
      • PBMeshCollider_SphereMesh
      • PBMeshRenderer
      • PBMeshRenderer_BoxMesh
      • PBMeshRenderer_CylinderMesh
      • PBMeshRenderer_PlaneMesh
      • PBMeshRenderer_SphereMesh
      • PBNftShape
      • PBParticleSystem
      • PBParticleSystem_Box
      • PBParticleSystem_Burst
      • PBParticleSystem_BurstConfiguration
      • PBParticleSystem_Cone
      • PBParticleSystem_LimitVelocity
      • PBParticleSystem_Point
      • PBParticleSystem_Sphere
      • PBParticleSystem_SpriteSheetAnimation
      • PBPhysicsCombinedForce
      • PBPhysicsCombinedImpulse
      • PBPlayerIdentityData
      • PBPointerEvents
      • PBPointerEventsResult
      • PBPointerEvents_Entry
      • PBPointerEvents_Info
      • PBPointerLock
      • PBPosition
      • PBPrimaryPointerInfo
      • PBQuaternion
      • PBRaycast
      • PBRaycastResult
      • PBRealmInfo
      • PBSkyboxTime
      • PBTextShape
      • PBTouchScreenControls
      • PBTouchScreenControls_TouchInput
      • PBTriggerArea
      • PBTriggerAreaResult
      • PBTriggerAreaResult_Trigger
      • PBTween
      • PBTweenSequence
      • PBTweenState
      • PBUiBackground
      • PBUiCanvasInformation
      • PBUiDropdown
      • PBUiDropdownResult
      • PBUiInput
      • PBUiInputBinding
      • PBUiInputResult
      • PBUiText
      • PBUiTransform
      • PBVector2
      • PBVector3
      • PBVideoEvent
      • PBVideoPlayer
      • PBVirtualCamera
      • PBVisibilityComponent
      • PutComponentOperation
      • PutNetworkComponentOperation
      • RaycastHit
      • Rect
      • Rotate
      • RotateContinuous
      • Scale
      • Schemas
      • Texture
      • TextureMove
      • TextureMoveContinuous
      • TextureUnion
      • VideoTexture
    • Etherum Provider
    • Math & Colors
      • Color3
      • Color4
      • Matrix
      • Plane
      • Quaternion
      • Scalar
      • Vector2
      • Vector3
    • ReactEcs
      • ReactEcs
        • JSX
    • js-runtime/apis
      • "~system/CommsApi"
      • "~system/CommunicationsController"
      • "~system/EngineApi"
      • "~system/EnvironmentApi"
      • "~system/EthereumController"
      • "~system/Players"
      • "~system/PortableExperiences"
      • "~system/RestrictedActions"
      • "~system/Runtime"
      • "~system/Scene"
      • "~system/SignedFetch"
      • "~system/Testing"
      • "~system/UserActionModule"
      • "~system/UserIdentity"
    • sdk/src/composite-provider
    • sdk/src/ethereum-provider/text-encoder
    • sdk/src/explorer-ui
    • sdk/src/network
    • sdk/src/network/binary-message-bus
    • sdk/src/network/entities
    • sdk/src/network/filter
    • sdk/src/network/message-bus-sync
    • sdk/src/network/state
    • sdk/src/network/utils
    • sdk/src/platform
    • sdk/src/players
    • sdk/src/text-codec
  • channel
  • openExplorerUiAndWait
  • variant
  • ExplorerUiEvents
  • ItemPurchase
  • OpenExplorerUiAndWait
  • AnyChannel
  • CaseOf
  • Channel
  • Collected
  • CorrelatedEvent
  • OpenExplorerUiRequest
  • StopCondition
  • Variant
  • WaitOptions
  • WaitOutcome
  • ExplorerUi
  • OpenExplorerUiResult