メインコンテンツまでスキップ

型定義

WebviewSource

3 種類のソース型のユニオンです。webviewSource ヘルパーを使用して常に作成してください:

ヘルパー生成される型フィールド
webviewSource.local(id)WebviewSourceLocal{ type: "local", id }
webviewSource.url(url)WebviewSourceUrl{ type: "url", url }
webviewSource.html(content)WebviewSourceHtml{ type: "html", content }

WebviewSourceLocal

フィールド説明
type"local"判別子
idstringアセット ID(例:"my-mod:ui"

WebviewSourceUrl

フィールド説明
type"url"判別子
urlstringURL 文字列

WebviewSourceHtml

フィールド説明
type"html"判別子
contentstringHTML 文字列

WebviewSourceInfo

API レスポンスで返される WebView ソース情報。WebviewSourceInfoLocalWebviewSourceInfoUrlWebviewSourceInfoHtml のユニオンです。リストレスポンスでは HTML コンテンツは省略されます。

WebviewSourceInfoLocal

フィールド説明
type"local"判別子
idstringアセット ID

WebviewSourceInfoUrl

フィールド説明
type"url"判別子
urlstringURL 文字列

WebviewSourceInfoHtml

フィールド説明
type"html"判別子
contentstring | undefinedHTML 文字列(リストレスポンスでは省略)

WebviewInfo

Webview.list()webview.info() から返されます。

フィールド説明
entitynumberWebView のエンティティ ID
sourceWebviewSourceInfo現在のソース
sizeVec23D ワールド空間の寸法
viewportSizeVec2HTML ピクセル寸法
offsetVec2位置オフセット
linkedVrmnumber | nullリンクされた VRM のエンティティ ID、または null

WebviewPatchRequest

patch() で使用します。

フィールド説明
offsetVec2新しい位置オフセット
sizeVec2新しい 3D 寸法
viewportSizeVec2新しいピクセル寸法

WebviewOpenOptions

Webview.open() で使用します。

フィールドデフォルト説明
sourceWebviewSource--表示内容(必須)
sizeVec2--3D ワールド空間での寸法
viewportSizeVec2--HTML ピクセル寸法
offsetVec2--リンクされた VRM またはワールド原点からの相対位置
linkedVrmnumber--アタッチする VRM のエンティティ ID

WebviewNavigateRequest

navigate() が内部で使用します。

フィールド説明
sourceWebviewSourceナビゲート先の新しいソース

SetLinkedVrmRequest

setLinkedVrm() が内部で使用します。

フィールド説明
vrmnumberリンクする VRM のエンティティ ID