Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/.vuepress/sidebar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export const zhSidebar = sidebar({
prefix: "others/",
children:[
"transform-reference",
"animation-reference",
]
},
],
Expand Down
2 changes: 1 addition & 1 deletion src/script-reference/commands/setAnimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## 语句内容

填写自定义动画名称,驱动指定目标的舞台对象执行多段动画。
详情请见[自定义动画](../../webgal-script/animation.md#自定义动画)。
详情请见[自定义动画](../../webgal-script/animation.md#自定义动画)和[动画参考](../others/animation-reference.md)

:::info
如果您想直接在脚本里设置多段动画,请使用 [setTempAnimation](setTempAnimation.md) 命令。
Expand Down
2 changes: 1 addition & 1 deletion src/script-reference/commands/setTempAnimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 语句内容

与 `setAnimation` 读取动画文件不同,`setTempAnimation` 允许用户直接在代码里定义多段动画。
与 `setAnimation` 读取动画文件不同,`setTempAnimation` 允许用户直接在代码里定义多段动画,详见[动画参考](../others/animation-reference.md)
语句内容格式为动画文件的单行形式,即 `[{},{},{}]` 。

:::info
Expand Down
117 changes: 117 additions & 0 deletions src/script-reference/others/animation-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# 动画参考

WebGAL 支持设置连续的 [变换效果](../others/transform-reference.md) ,从而实现多段动画。

一个变换效果对象如
``` json
{
"position": {
"x":-500,
"y":20
},
"rotation":0.3,
"blur":10
}
```

一个动画片段对象则是在变换效果对象的基础上,添加了一些其他属性,如持续时间等
``` json
{
"position": {
"x":-500,
"y":20
},
"rotation":0.3,
"blur":10,
"duration":500,
"ease":"easeInOut"
}
```

多个动画片段对象可以组成一个动画
``` json
[
{
"duration":0
},
{
"position": {
"x":-500,
"y":20
},
"duration":500
},
{
"rotation":0.3,
"duration":300
},
{
"blur":10,
"duration":200
}
]
```

除了一些必要的属性外(如 duration),动画片段对象的很多属性都可以省略,WebGAL 会根据情况使用默认值或者继承现有值来补全。

:::info
继承现有值的「现有值」是指,在执行动画前,目标对象的变换效果快照,而不是上一个动画片段的结束状态。
:::

```webgal
; 立绘对象初始坐标为 (-500,0)
changeFigure:character_a/normal.png -id=aaa -transform={"position":{"x":-500,"y":0}};
; 多段动画的坐标依次为
; (-500,0) -> (500,0) -> (-500,20)
setTempAnimation:[{"duration":0},{"position":{"x":500},"duration":500},{"position":{"y":20},"duration":500}] -target=aaa;
```

动画里的第一个片段为起始状态,通常 duration 设为 0 即可,即使设置了大于 0 的数,也不会有动画效果。
您仍然可以为第一个片段设置变换效果属性,这样可以在动画开始时直接跳转到指定状态。

```webgal
; 立绘对象初始坐标为 (-500,0)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

这行注释 立绘对象初始坐标为 (-500,0) 具有误导性。在 changeFigure 命令中并未指定 transform,因此立绘的初始坐标应为默认的 (0,0)。动画的第一个片段 {"position":{"x":-500},"duration":0} 实际上是将立绘瞬移(-500,0) 位置,然后才开始后续动画。

为了确保文档的准确性,建议修改此注释以反映真实的初始状态。

Suggested change
; 立绘对象初始坐标为 (-500,0)
; 立绘对象初始坐标为 (0,0)

changeFigure:character_a/normal.png -id=aaa;
; 从左走到右,动画开始时直接跳转到左边
setTempAnimation:[{"position":{"x":-500},"duration":0},{"position":{"x":500},"duration":1000}] -target=aaa;
```

## 参数

### duration
- 数字
- 单位:毫秒
- 必填

每个动画片段的持续时间。

```webgal
changeFigure:1/open_eyes.png -id=aaa;
setTempAnimation:[{"position":{"x":-500},"duration":0},{"position":{"x":500},"duration":1000}] -target=aaa;
```

### ease
- 字符串

填写缓动类型,控制动画的缓动效果,默认值为 `easeInOut`,可选值包括
- `linear`:线性
- `easeIn`:缓入
- `easeOut`:缓出
- `easeInOut`:缓入缓出
- `circIn`:圆形缓入
- `circOut`:圆形缓出
- `circInOut`:圆形缓入缓出
- `backIn`:起点回弹
- `backOut`:终点回弹
- `backInOut`:起止回弹
- `bounceIn`:起点弹跳
- `bounceOut`:终点弹跳
- `bounceInOut`:起止弹跳
- `anticipate`:预先反向

任何其他字符串都会回退到默认值。

```webgal
changeFigure:1/open_eyes.png -id=aaa;
setTempAnimation:[{"position":{"x":-500},"duration":0},{"position":{"x":500},"duration":1000,"ease":"bounceOut"}] -target=aaa;
```