mirror of
https://github.com/unanmed/HumanBreak.git
synced 2026-11-18 21:44:30 +08:00
feat: API文档
This commit is contained in:
1 parent
85031d3c39
commit
121fbe369d
59 files changed
+5965
-59
No files matched your search
@@ -0,0 +1,57 @@
|
||||
# 模块 CustomComponents
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用。
|
||||
|
||||
这个模块包含了一些系统使用的函数式组件。
|
||||
|
||||
- 函数
|
||||
- [`createSettingComponents`](#createsettingcomponents)
|
||||
- [`createToolbarComponents`](#createtoolbarcomponents)
|
||||
- [`createToolbarEditorComponents`](#createtoolbareditorcomponents)
|
||||
|
||||
## createSettingComponents()
|
||||
|
||||
```ts
|
||||
declare function createSettingComponents(): {
|
||||
Default: SettingComponent
|
||||
Boolean: SettingComponent
|
||||
Number: SettingComponent
|
||||
HotkeySetting: SettingComponent
|
||||
ToolbarEditor: SettingComponent
|
||||
Radio: (items: string[]) => SettingComponent
|
||||
}
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
获取所有的设置的编辑组件,参考 [指南](../../guide/setting.md#注册设置)
|
||||
|
||||
## createToolbarComponents()
|
||||
|
||||
```ts
|
||||
declare function createToolbarComponents(): {
|
||||
DefaultTool: CustomToolbarComponent;
|
||||
KeyTool: CustomToolbarComponent;
|
||||
ItemTool: CustomToolbarComponent;
|
||||
AssistKeyTool: CustomToolbarComponent;
|
||||
}
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
获取所有的自定义工具项显示组件
|
||||
|
||||
## createToolbarEditorComponents()
|
||||
|
||||
```ts
|
||||
declare function createToolbarEditorComponents(): {
|
||||
DefaultTool: CustomToolbarComponent;
|
||||
KeyTool: CustomToolbarComponent;
|
||||
ItemTool: CustomToolbarComponent;
|
||||
AssistKeyTool: CustomToolbarComponent;
|
||||
}
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
获取所有自定义工具项的编辑组件,即在系统设置的自定义工具栏项内的编辑组件
|
||||
@@ -0,0 +1,70 @@
|
||||
# 模块 Damage
|
||||
|
||||
游戏进程类,渲染进程也可以使用
|
||||
|
||||
包含了部分伤害计算相关的函数与变量
|
||||
|
||||
- 变量
|
||||
- [`haloSpecials`](#halospecials)
|
||||
- [`changeableHaloValue`](#changeablehalovalue)
|
||||
- [`realStatus`](#realstatus)
|
||||
- 函数
|
||||
- [`calDamageWith`](#caldamagewith)
|
||||
- [`ensureFloorDamage`](#ensurefloordamage)
|
||||
- [`getSingleEnemy`](#getsingleenemy)
|
||||
|
||||
## haloSpecials
|
||||
|
||||
```ts
|
||||
declare var haloSpecials: Set<number>
|
||||
```
|
||||
|
||||
- 变量说明
|
||||
|
||||
保存了所有的光环类属性
|
||||
|
||||
## changeableHaloValue
|
||||
|
||||
```ts
|
||||
declare var changeableHaloValue: Map<number, string[]>
|
||||
```
|
||||
|
||||
- 变量说明
|
||||
|
||||
包含了所有会被第一类光环影响的特殊属性数值
|
||||
|
||||
## realStatus
|
||||
|
||||
```ts
|
||||
declare var realStatus: string[]
|
||||
```
|
||||
|
||||
- 变量说明
|
||||
|
||||
计算伤害时会用到的勇士属性,攻击防御,其余的不会有 buff 加成,直接从 core.status.hero 取
|
||||
|
||||
## calDamageWith()
|
||||
|
||||
```ts
|
||||
declare function calDamageWith(info: EnemyInfo, hero: Partial<HeroStatus>): number | null
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
计算怪物伤害的函数,示例参考插件
|
||||
|
||||
## ensureFloorDamage()
|
||||
|
||||
```ts
|
||||
declare function ensureFloorDamage(floor: string): void
|
||||
```
|
||||
|
||||
## getSingleEnemy()
|
||||
|
||||
```ts
|
||||
declare function getSingleEnemy(id: string): DamageEnemy
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
用于获取一个不在地图上的单个怪物,不会受到任何光环的影响
|
||||
@@ -0,0 +1,5 @@
|
||||
# 模块 KeyCodes
|
||||
|
||||
渲染进程类,游戏进程不可直接使用
|
||||
|
||||
摘自 vscode 的 keyCodes.ts,这里不再赘述,直接参考 vscode 源码即可,里面常用的两个枚举 `KeyCode` 及 `ScanCode` 已经在变量 API 中列举。
|
||||
@@ -0,0 +1,51 @@
|
||||
# 模块 Mark
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用
|
||||
|
||||
该模块包含了标记怪物相关的功能
|
||||
|
||||
- 函数
|
||||
- [`markEnemy`](#markenemy)
|
||||
- [`unmarkEnemy`](#unmarkenemy)
|
||||
- [`checkMarkedEnemy`](#checkmarkedenemy)
|
||||
- [`hasMarkedEnemy`](#hasmarkedenemy)
|
||||
|
||||
## markEnemy()
|
||||
|
||||
```ts
|
||||
declare function markEnemy(id: string): void
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
标记一个指定 id 的怪物
|
||||
|
||||
## unmarkEnemy()
|
||||
|
||||
```ts
|
||||
declare function unmarkEnemy(id: string): void
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
取消标记指定 id 的怪物
|
||||
|
||||
## checkMarkedEnemy()
|
||||
|
||||
```ts
|
||||
declare function checkMarkedEnemy(): void
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
检查所有标记的怪物状态
|
||||
|
||||
## hasMarkedEnemy()
|
||||
|
||||
```ts
|
||||
declare function hasMarkedEnemy(id: string): boolean
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
判断一个怪物是否被标记
|
||||
@@ -0,0 +1,5 @@
|
||||
# 模块 MCGenerator
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用。
|
||||
|
||||
参考 [UI 编写](../../guide/ui.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# 模块 MiscComponents
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用
|
||||
|
||||
包含了一些零散的 UI
|
||||
|
||||
- [`VirtualKey`](#virtualkey)
|
||||
|
||||
## VirtualKey
|
||||
|
||||
与 [`Keyboard`](./ui-components.md#keyboard) 一样
|
||||
@@ -0,0 +1,5 @@
|
||||
# 模块 RenderUtils
|
||||
|
||||
渲染进程类,游戏进程不能直接使用
|
||||
|
||||
包含了渲染进程中会用到的一些功能函数,可以查看类型标注来看有哪些,一般都有注释,这里不再赘述
|
||||
@@ -0,0 +1,86 @@
|
||||
# 模块 UIComponents
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用
|
||||
|
||||
包含了可以用在 UI 里面的可复用组件
|
||||
|
||||
- [`Box`](#box)
|
||||
- [`BoxAnimate`](#boxanimate)
|
||||
- [`Column`](#column)
|
||||
- [`EnemyOne`](#enemyone)
|
||||
- [`Scroll`](#scroll)
|
||||
- `EnemyCritical`
|
||||
- `EnemySpecial`
|
||||
- `EnemyTarget`
|
||||
- [`Keyboard`](#keyboard)
|
||||
|
||||
## Box
|
||||
|
||||
一个可以拖动的盒子,例如状态栏
|
||||
|
||||
- 参数(均为可选)
|
||||
- `dragable`: 盒子是否可以拖动
|
||||
- `resizeable`: 盒子是否可以自定义大小
|
||||
- `v-model:left`: 盒子的左上角横坐标
|
||||
- `v-model:top`: 盒子的左上角纵坐标
|
||||
- `v-model:width`: 盒子的宽度
|
||||
- `v-model:height`: 盒子的高度
|
||||
- 插槽
|
||||
- `default`: 盒子中显示的内容
|
||||
|
||||
## BoxAnimate
|
||||
|
||||
一个显示图块动画的组件,例如怪物手册中的怪物图标
|
||||
|
||||
- 参数
|
||||
- `id`: 显示的图标 id
|
||||
- `noboarder`: 可选,是否没有边框与背景
|
||||
- `width`: 可选,图标的宽度,默认为 32
|
||||
- `height`: 可选,图标的高度,默认为 32
|
||||
|
||||
## Column
|
||||
|
||||
一个分为两栏进行显示的组件,例如设置快捷键中左右两侧中左侧显示按键分组,右侧显示组别信息
|
||||
|
||||
- 参数(均为可选)
|
||||
- `width`: 组件整体的宽度,占画面的百分比,一般不建议超过 90
|
||||
- `height`: 组件整体的高度,占画面的百分比,一般不建议超过 90
|
||||
- `left`: 左侧栏占比,范围 0-100
|
||||
- `right`: 右侧栏占比,范围 0-100
|
||||
- 事件
|
||||
- `close`: 当点击左上角的返回后触发这个事件
|
||||
- 插槽
|
||||
- `left`: 左侧栏显示的内容
|
||||
- `right`: 右侧栏显示的内容
|
||||
|
||||
## EnemyOne
|
||||
|
||||
显示单个怪物信息,就是怪物手册中的单个怪物信息
|
||||
|
||||
- 参数
|
||||
- `enemy`: 怪物信息,类型为 `ToShowEnemy`
|
||||
- `selected`: 这个怪物是否被选中
|
||||
- 事件
|
||||
- `hover`: 当鼠标放到这个怪物身上或在怪物身上移动时触发
|
||||
- `select`: 当选中这个怪物时触发
|
||||
|
||||
## Scroll
|
||||
|
||||
滚动条组件,例如状态栏等
|
||||
|
||||
- 参数(均为可选)
|
||||
- `v-model:now`: 当前滚动条位置
|
||||
- `type`: 滚动条模式,`horizontal` 还是 `vertical`,默认为竖直,即 `vertical`
|
||||
- `v-model:drag`: 是否正在拖动
|
||||
- `width`: 滚动条的宽度
|
||||
- `v-model:update`: 取反以更新滚动条信息
|
||||
- `noScroll`: 不显示滚动条,例如状态栏
|
||||
- 插槽
|
||||
- `default`: 滚动条内的显示内容
|
||||
|
||||
## Keyboard
|
||||
|
||||
虚拟键盘组件
|
||||
|
||||
- 参数
|
||||
- `keyboard`: 要显示哪个虚拟键盘
|
||||
@@ -0,0 +1,5 @@
|
||||
# 模块 UITools
|
||||
|
||||
渲染进程类,游戏进程不能直接使用
|
||||
|
||||
包含了样板自带 UI 所使用到的部分功能性函数,内容过多,这里不再赘述,一般也用不到,如果想了解的话直接在群里面问就行,或者去查看源码。拥有完整的类型标注
|
||||
@@ -0,0 +1,24 @@
|
||||
# 模块 UI
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用
|
||||
|
||||
包含游戏中的所有 UI
|
||||
|
||||
- `Book`
|
||||
- `BookDetail`
|
||||
- `Chapter`
|
||||
- `Equipbox`
|
||||
- `Fixed`
|
||||
- `FixedDetail`
|
||||
- `Fly`
|
||||
- `Marked`
|
||||
- `Settings`
|
||||
- `Shop`
|
||||
- `Start`
|
||||
- `StatusBar`
|
||||
- `Toolbox`
|
||||
- `Hotkey`
|
||||
- `Toolbar`
|
||||
- `ToolEditor`
|
||||
|
||||
以上 UI 中均包含 `ui` 和 `num` 两个参数
|
||||
@@ -0,0 +1,106 @@
|
||||
# 模块 Use
|
||||
|
||||
渲染进程模块,游戏进程不能直接使用
|
||||
|
||||
此模块包含了若干与 DOM 相关的功能函数与变量
|
||||
|
||||
- 变量
|
||||
- [`isMobile`](#ismobile)
|
||||
- 函数
|
||||
- [`useDrag`](#usedrag)
|
||||
- [`cancelGlobalDrag`](#cancelglobaldrag)
|
||||
- [`useWheel`](#usewheel)
|
||||
- [`useUp`](#useup)
|
||||
- [`useDown`](#usedown)
|
||||
|
||||
## isMobile
|
||||
|
||||
```ts
|
||||
declare var isMobile: boolean
|
||||
```
|
||||
|
||||
- 变量说明
|
||||
|
||||
表明是否是移动端,不过应该是没用的。。
|
||||
|
||||
## useDrag()
|
||||
|
||||
```ts
|
||||
declare function useDrag(
|
||||
ele: HTMLElement | HTMLElement[],
|
||||
fn: DragFn,
|
||||
ondown?: DragFn,
|
||||
onup?: (e: MouseEvent | TouchEvent) => void,
|
||||
global: boolean = false
|
||||
): void
|
||||
```
|
||||
|
||||
- 类型说明
|
||||
|
||||
```ts
|
||||
type DragFn = (x: number, y: number, e: MouseEvent | TouchEvent) => void
|
||||
```
|
||||
|
||||
- 参数说明
|
||||
|
||||
- `ele`: 目标元素,当为全局拖拽时,传入数组表示所有元素共用一个全局拖拽函数
|
||||
- `fn`: 拖拽时触发的函数,传入 x y 和鼠标事件或点击事件
|
||||
- `ondown`: 鼠标按下时执行的函数
|
||||
- `global`: 是否全局拖拽,即拖拽后鼠标或手指离开元素后是否依然视为正在拖拽
|
||||
|
||||
- 函数说明
|
||||
|
||||
向一个或若干个元素添加拖拽事件,如果是全局拖拽,当目标元素被销毁后,必须调用 `cancelGlobalDrag` 函数
|
||||
|
||||
## cancelGlobalDrag()
|
||||
|
||||
```ts
|
||||
declare function cancelGlobalDrag(fn: DragFn): void
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
取消一个全局拖拽函数,传入拖拽函数引用
|
||||
|
||||
## useWheel()
|
||||
|
||||
```ts
|
||||
declare function useWheel(
|
||||
ele: HTMLElement,
|
||||
fn: (x: number, y: number, z: number, e: WheelEvent) => void
|
||||
): void
|
||||
```
|
||||
|
||||
- 参数说明
|
||||
|
||||
- `ele`: 要添加滚轮监听函数的元素
|
||||
- `fn`: 当滚轮滚动时,执行的函数
|
||||
|
||||
- 函数说明
|
||||
|
||||
当触发滚轮时执行函数
|
||||
|
||||
## useUp()
|
||||
|
||||
```ts
|
||||
declare function useUp(ele: HTMLElement, fn: DragFn): void
|
||||
```
|
||||
|
||||
- 参数说明
|
||||
|
||||
- `ele`: 要监听的元素
|
||||
- `fn`: 当鼠标抬起或手指抬起时,触发的函数
|
||||
|
||||
- 函数说明
|
||||
|
||||
当手指或鼠标抬起时触发函数
|
||||
|
||||
## useDown()
|
||||
|
||||
```ts
|
||||
declare function useDown(ele: HTMLElement, fn: DragFn): void
|
||||
```
|
||||
|
||||
- 函数说明
|
||||
|
||||
与 [`useUp`](#useup) 类似,不过触发时机变为了手指或鼠标按下时触发
|
||||
Reference in new issue
Block a user