xverse-components-world v1.0.20
API
参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 | ||
---|---|---|---|---|---|---|---|
env | 'sit' | 'uat' | 'prod' | sit | false | - | |
consoleEnv | 'sit' | 'uat' | 'prod' | sit | false | - | |
appId | string | 应用 ID | - | true | - | ||
releaseId | string | releaseId | - | false | - | ||
globalDataVersionId | string | 数据版本 ID | - | false | - | ||
worldId | IWorldId | 3D 世界 ID | - | true | - | ||
bgImage | string | 应用默认背景图 | - | true | 项目代码加载中时,当有应用默认背景色时,背景图片没有加载完之前则只展示背景色,背景图片加载完则展示背景图,上传背景图后会自动生成背景色。 | ||
bgColor | string | 应用默认背景色 | - | true | 项目代码加载中时,当有应用默认背景图时,背景图片没有加载完之前则只展示背景色,背景图片加载完则展示背景图,上传背景图后会自动生成背景色。 | ||
movementTriggerMode | 'autoNavigation' | 'joystick' | 'clickWithJoystick' | 玩家行进方式 | joystick | false | 默认为 joystick,摇杆模式; autoNavigation 表示点击行走, 该模式下不创建 Avatar; clickWithJoystick 表示点击行走和遥感双模式 |
isKeyboard | boolean | 是否开启键盘控制人物行进 | - | false | 是否可以通过键盘的 WASD | ↑←↓→ 建控制行进 | |
joystickConfig | IJoystickProps | 摇杆参数配置 | - | false | - | ||
forbiddenWatermark | boolean | 线上 prod 是否禁用 uid 水印 | true | false | 非 prod 环境默认开启 | ||
obstacleThroughEnable | boolean | 是否开启人物透视功能 | - | false | 即靠近镜头的人物会被虚化显示,默认关闭 | ||
isNotMediaByDc | boolean | 是否启用 1080P 硬解 | - | false | 为 true 表示使用硬解(开启前,辛苦和美术确认是否使用 1080P 渲染的场景,或查看 config.json 中的 imageEncodeType 字段) | ||
isClosePreSpawn | boolean | 是否关闭预创建 3D 资产 | - | false | - | ||
serverless | boolean | 本地全景图进房 | - | false | 值为 true 时优先使用本地全景图进房,失败兜底无网模式进房 | ||
signalUrl | string | websocket 连接地址,默认为'' | - | false | 开发阶段,可以输入后台的 ws 地址进行联调 | ||
reloadUrl | string | app 异常重新进入时的 url | - | false | 不设置则为 app 的 h5 链接,对于内嵌到其他应用,需要对方重定向才展示当前 h5 链接时,需要填为对方提供的链接 | ||
avatarProps | Omit< |
IAvatarProps,
| 'avatarId'
| 'avatarImg'
| 'birthPointId'
| 'userId'
| 'nickName'
| 'isNPC'
| 'hairPath'
| 'clothesPath'
| 'pantsPath'
| 'shoesPath'
| 'suitPath'
|第三人称玩家自身配置|-|false|第一人称隐藏玩家自己,不需要该配置| |isFromCloudSyncAvatar|boolean|是否从云上同步装扮 Avatar|-|false|-| |poorNetJudge|number|预加载判定标准|15|false|连续 poorNetJudge 秒没有任何资产下载完成,即判定为预加载失败| |fps|number|3D 世界渲染帧率|25|false|会以该值为帧率进行渲染,绝大部分情况无需修改| |tolerableFPS|number|可容忍的 FPS|15|false|FPS 低于该值认为不可容忍,持续一段时间需要退出 3D 世界| |tolerableLowfpsRatePct|number|低于可容忍的 FPS 的时间比例,单位%|70|false|最近 30s,有 n% 的时间 FPS 都低于可容忍值,就会退出 3D 世界| |userId|string||-|false|-| |avatarIdList|string[]||-|false|-| |appVersion|string||-|false|-| |canvas|string||-|false|-| |token|string||-|false|-| |maxVideoCount|number||-|false|-| |maxAudioCount|number||-|false|-| |allRoomKeyList|IPreCreateRoomItem[]||-|false|-| |onReconnected|() => void|重连回调|-|false|-| |onReconnecting|() => void|重连中回调 3 次|-|false|-| |onAvatarClick|(props: { userId: string }) => void|同步的 avatar 被点击时事件|-|false|-| |onAvatarLongPress|(props: { userId: string }) => void|同步的 avatar 被长按时事件|-|false|-| |onAvatarBubbleClick|(props: { userId: string }) => void|同步的 avatar 的头顶气泡被点击时事件|-|false|-| |onOtherAvatarLoaded|(props: { userId: string }) => void|其他的 avatar 的 load|-|false|-| |onClickOutOfNavMeshPoint|() => void|点击可行进区域外的点|-|false|-| |onEnterOB|() => void|前往 OB 模式|-|false|-|
13 days ago
23 days ago
26 days ago
26 days ago
27 days ago
27 days ago
30 days ago
1 month ago
1 month ago
1 month ago
2 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
6 months ago
6 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago