Skip to content

Commit c4db176

Browse files
committed
Add documentation for shake effect
1 parent 4af531e commit c4db176

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

docs/reference/elements/shake.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
# [command] shake
3+
4+
Shakes a displayable asset. This is similar to the punch effects known from Ren'Py.
5+
6+
7+
## Usage
8+
9+
. shake @my_image, :200, times 4
10+
11+
12+
## Attributes
13+
14+
* **asset/@[value]:** The asset's internal name.
15+
* **duration:** The duration for the effect to last in milliseconds. Default: 275.
16+
* **times:** The number of times the asset shakes back and forth.
17+
* **ifvar:** See [conditionals](conditionals.md).
18+
* **ifvalue:** See [conditionals](conditionals.md).
19+
* **ifnot:** See [conditionals](conditionals.md).
20+
21+
22+
## Parents
23+
24+
* [scene](scene.md)
25+
26+
27+
## Children
28+
29+
* none
30+
31+
32+
## Related Assets
33+
34+
* [imagepack](imagepack.md)
35+
* [textbox](textbox.md)
36+
* [curtain](curtain.md)
37+
38+
39+
## Related Commands
40+
41+
* [flicker](flicker.md)
42+

0 commit comments

Comments
 (0)