跳转至

API 速查表

这个页面是干什么的

鉴于API太多，目录过于混乱，故有此页面
这个页面根据用途分类API（以后目录也可能这么分）
该页面只包含JS/TS 参考、API 参考、Client API 参考的内容

提示

每张卡片代表一个大功能（模块）的内容，一张卡片里，每一行的所有图标都指向同一个链接

  • 代表页面已完成
  • 代表页面未完成

JS/TS参考

  • Javascript 基本类型

    • string & String 字符串
    • number & Number 数字
    • boolean & Boolean 布尔值
    • null 空值
    • undefined 未定义

  • Typescript 类型

    • any 任意类型
    • void 无类型
    • never
    • Partial

API 参考

  • 世界相关

    • world & Box3World / GameWorld 世界
    • Box3TickEvent / GameTickEvent 时钟事件
    • 实体创建/销毁
      • Box3EntityEvent / GameEntityEvent 实体创建销毁事件
      • Box3PlayerEntityEvent / GamePlayerEntityEvent 玩家实体创建销毁事件
    • 区域
      • Box3Zone / GameZone 区域
      • Box3TriggerEvent / GameTriggerEvent 触发器事件
      • Box3ZoneConfig / GameZoneConfig 区域配置
    • 实体选择
      • Box3SelectorString / GameSelectorString
    • 射线检测
      • Box3RaycastOptions / GameRaycastOptions 射线检测配置
      • Box3RaycastResult / GameRaycastResult 射线检测结果

  • 方块

    • voxels & Box3Voxels / GameVoxels 方块

  • 实体相关

    • Box3Entity / GameEntity 实体
    • Box3EntityConfig / GameEntityConfig 实体配置
    • 互动相关
      • Box3InteractEvent / GameInteractEvent 实体互动事件
    • 动作相关
      • GameMotionController 动作控制器
      • GameMotionHandler 动作处理器
      • GameMotionEvent 动作事件（Arena编辑器）
      • GameMotionConfig 动作配置
      • GameMotionClipConfig 动作序列配置
    • 物理相关
      • Box3EntityContact / GameEntityContact 实体碰撞数据
      • Box3VoxelContact / GameVoxelContact 方块碰撞数据
      • Box3FluidContact / GameFluidContact 液体碰撞数据
      • Box3EntityContactEvent / GameEntityContactEvent 实体碰撞事件
      • Box3VoxelContactEvent / GameVoxelContactEvent 方块碰撞事件
      • Box3FluidContactEvent / GameFluidContactEvent 液体碰撞事件
    • 战斗相关
      • Box3HurtOptions / GameHurtOptions 实体伤害配置
      • Box3DamageEvent / GameDamageEvent 实体伤害事件
      • Box3DieEvent / GameDieEvent 实体死亡事件

  • 玩家相关

    • Box3Player / GamePlayer 玩家
    • Box3PlayerEntity / GamePlayerEntity 玩家实体
    • PlayerNavigator 用户设备相关
    • SocialType 社交类型
    • 战斗相关
      • Box3RespawnEvent / GameRespawnEvent 玩家重生事件
    • 穿戴配件
      • Box3Wearable / GameWearable 穿戴配件
      • Box3BodyPart / GameBodyPart 身体部件类型
    • 输入
      • Box3ChatEvent / GameChatEvent 聊天事件
      • Box3ClickEvent / GameClickEvent 点击事件
      • Box3InputEvent / GameInputEvent 输入事件
      • Box3ButtonType / GameButtonType 按键类型
      • GameKeyBoardEvent 键盘事件
    • 摄像机相关
      • Box3CameraMode / GameCameraMode 摄像机模式
      • Box3InputDirection / GameInputDirection 输入方向
      • Box3CameraFreezedAxis / GameCameraFreezedAxis
    • 运动相关
      • Box3PlayerMoveState / GamePlayerMoveState 玩家移动状态
      • Box3PlayerWalkState / GamePlayerWalkState 玩家步行状态
    • 对话框相关
      • Box3DialogType / GameDialogType 对话框类型
      • Box3DialogCall / GameDialogCall 对话框调用
      • Box3DialogParams / GameDialogParams 对话框配置
      • Box3DialogSelectResponse / GameDialogSelectResponse 选择对话框结果
      • Box3DialogCancelOption / GameDialogCancelOption 对话框取消选项
    • 皮肤相关
      • GameSkin 皮肤
      • GameSkinValue 皮肤值
      • GameSkinInvisible 皮肤隐藏设置

  • 数据库（旧版编辑器）

    • db & Box3Database / GameDatabase 数据库
    • Box3QueryResult / GameQueryResult 数据查找结果

  • 数据储存（Arena编辑器）

    • storage & GameStorage 数据储存
    • GameDataStorage 数据存储空间
    • QueryList 数据查询列表
    • ListPageOptions 列表翻页配置
    • ReturnValue 数据查询返回

  • 事件

    • Box3EventChannel / GameEventChannel 事件频道
    • Box3EventFuture / GameEventFuture
    • Box3EventHandlerToken / GameEventHandlerToken 事件令牌

  • Box3 基本数据类型

    • Box3Vector3 / GameVector3 三维向量
    • Box3Quaternion / GameQuaternion 四元数
    • Box3Bounds3 / GameBounds3 三维区域空间
    • Box3RGBColor / GameRGBColor RGB颜色
    • Box3RGBAColor / GameRGBAColor RGBA颜色
    • JSONValue 类JSON格式

  • 数据通信

    • remoteChannel & ServerRemoteChannel
    • ServerEvent（Arena编辑器）

  • 动画

    • Box3Animation / GameAnimation
    • Box3AnimationEvent / GameAnimationEvent 动画事件
    • Box3AnimationPlaybackState / GameAnimationPlaybackState 动画播放状态
    • Box3AnimationDirection / GameAnimationDirection 动画播放方向
    • Box3Easing / GameEasing 动画缓动效果
    • Box3WorldKeyframe / GameWorldKeyframe 世界关键帧
    • Box3EntityKeyframe / GameEntityKeyframe 实体关键帧
    • Box3PlayerKeyframe / GamePlayerKeyframe 玩家关键帧
    • Box3AnimationPlaybackConfig / GameAnimationPlaybackConfig 动画播放配置参数

  • 声音

    • Sound（Arena编辑器）
    • Box3SoundEffect / GameSoundEffect 声音效果配置

  • 用户图形界面

    • gui & GameGUI GUI
    • GUIConfig GUI配置

  • 实时语言通信

    • rtc & GameRTC 游戏内实时语言通信
    • GameRTCChannel RTC通道

  • HTTP

    • http & Box3HttpAPI / GameHttpAPI HTTP
    • Box3HttpFetchResponse / GameHttpFetchResponse 请求响应
    • Box3HttpRequest / GameHttpRequest [无效]HTTP请求
    • Box3HttpResponse / GameHttpResponse [无效]HTTP响应
    • Box3HttpFetchParams HTTP请求参数
    • GameHttpFetchRequestOptions HTTP请求配置
    • GameHttpFetchHeaders HTTP请求头配置
    • Box3HttpHandler / GameHttpHandler HTTP事件监听器

  • 控制台

    • console & GameConsole
    • Box3LoggerMethod / GameLoggerMethod 控制台方法

  • 资源文件

    • resources & Box3ResourceSystem / GameResourceSystem
    • Box3AssetListEntry / GameAssetListEntry 资源文件条目
    • Box3AssetType / GameAssetType 资源文件类型

Client API 参考

  • Client Box3 基本数据类型

    • Vec2 二维向量
    • Vec3 三维向量
    • Coord2 二维位置

  • 数据通信

    • remoteChannel & ClientRemoteChannel 数据通信（客户端）

  • Ui 节点

    • UiNode 节点
    • UiRenderable 可渲染节点
    • UiBox 框架节点
    • UiImage 图像节点
    • UiText 文本节点
    • UiInput 输入框节点
    • PointerEventBehavior 指针事件行为

  • 事件

    • EventEmitter 事件处理器
    • 监听器参数
      • UiEvent UI事件
      • UiInputEvent 输入节点事件
      • PointerLockEvents 鼠标指针锁定状态更改事件
    • 事件映射表
      • UiNodeEvents 节点事件
      • UiInputEvents 输入节点事件
      • PointerLockEvents 鼠标指针锁定事件
      • ClientRemoteChannelEvents 服务端消息事件

评论区