Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
imtaotao committed Aug 18, 2024
1 parent 4ddef69 commit 22602e0
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/src/content/docs/zh/case/anti-occlusion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 10
---

本章节将学习如何实现防遮挡功能,由于防遮挡功能需要定义被遮挡的范围,一般情况下,都是通过定义一个 svg 图片设置范围,然后通过 `CSS`[**`maskImage`**](https://developer.mozilla.org/en-US/docs/Web/CSS/mask-image) 属性来实现,主要是有以下两个步骤需要你来实现。
本章节将学习如何实现防遮挡功能,由于防遮挡功能需要定义被遮挡的范围,一般情况下,都是通过定义一个 `svg` 图片设置范围,然后通过 `CSS`[**`maskImage`**](https://developer.mozilla.org/en-US/docs/Web/CSS/mask-image) 属性来实现,主要是有以下两个步骤需要你来实现。

:::note

Expand Down
11 changes: 4 additions & 7 deletions docs/src/content/docs/zh/case/cooldown.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,15 @@ sidebar:

## 1. 根据弹幕内容来实现

```ts {16-26}
```ts {13-23}
import { create } from 'danmu';

const cd = 3000;
const map = Object.create(null);

// 创建 manager,定义发送弹幕的类型为 string
const manager = create<string>({ ... });

// 弹幕的 cd 时间为 3s
const cd = 3000;

// 记录弹幕上次发送的时间
const map = Object.create(null);

// 写一个插件来专门处理弹幕 cd 的事情
manager.use({
name: 'cd',
Expand Down
8 changes: 4 additions & 4 deletions docs/src/content/docs/zh/case/fixed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 9
---

本章节将介绍如何将弹幕固定在某一位置,以 **`top`****`left`** 这两个位置举例。由于我们需要自定义位置和禁止运动,所以我们需要使用高级弹幕的能力。
本章节将介绍如何将弹幕固定在某一位置,以 **`top`****`left`** 这两个位置举例。由于我们需要自定义位置,所以我们需要使用高级弹幕的能力。

:::note[提示]
以下这些代码你都可以复制,然后粘贴在在线 [**demo**](https://imtaotao.github.io/danmu/) 的控制台上查看效果。
Expand All @@ -15,7 +15,7 @@ sidebar:

**1. 固定在最顶部的位置:**

```ts
```ts {7-8}
// 这条弹幕将会居中距离顶部 10px 的位置悬停 5s
manager.pushFlexibleDanmaku('弹幕内容', {
duration: 5000,
Expand All @@ -31,7 +31,7 @@ manager.pushFlexibleDanmaku('弹幕内容', {

**2. 固定在顶部第 2 条轨道上:**

```ts
```ts {9-10}
// 这条弹幕将会在第二条轨道居中的位置悬停 5s
manager.pushFlexibleDanmaku('弹幕内容', {
duration: 5000,
Expand All @@ -49,7 +49,7 @@ manager.pushFlexibleDanmaku('弹幕内容', {

## 将弹幕固定在左边

```ts
```ts {7, 9-10}
// 这条弹幕将会在容器中间距离左边 10px 的地方停留 5s
manager.pushFlexibleDanmaku('弹幕内容', {
duration: 5000,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/zh/case/keyword.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar:

## 示例

```ts
```ts {4, 12}
import { create } from 'danmu';

// 定义关键字列表
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/zh/case/loop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ manager.push('弹幕内容', {
:::

```ts {15}
```ts {7, 11, 15}
let loops = 0;

manager.push('弹幕内容', {
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/zh/case/recommend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sidebar:
order: 12
---

由于在直播和视频直播中,弹幕的实时性要求比较高,而内置的碰撞算法配置 `strict` 的,所以当不满足渲染条件的时候会延迟到满足渲染条件后才渲染。**所以你应当设置为 `adaptive`**他会先尝试检查碰撞,看能够通过修正时间满足不碰撞的条件,但是如果不满足就会忽略碰撞算法而立即渲染
由于在直播和视频直播中,弹幕的实时性要求比较高,而默认的[**碰撞算法配置为**](../../reference/manager-config/#mode) `strict`,当不满足渲染条件的时候会延迟到满足渲染条件后才渲染,**所以你应当设置为 `adaptive`**这会让引擎会先尝试进行碰撞检测,如果不满足条件会忽略碰撞算法而立即渲染

```ts
```ts {4, 8}
// 在初始化的时候设置
const manager = create({
// ... 其他配置
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/zh/case/track.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 11
---

本章节学习如何控制轨道,我们可以将轨道控制在具体的数量来渲染,并且也可以控制具体哪几条
本章节学习如何控制轨道,我们可以将轨道控制在具体的数量来渲染。

:::note[提示]
以下这些代码你都可以复制,然后粘贴在在线 [**demo**](https://imtaotao.github.io/danmu/) 的控制台上查看效果。
Expand Down

0 comments on commit 22602e0

Please sign in to comment.