You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/03-custom-characters/03-02-creating-a-character.md
+9-10
Original file line number
Diff line number
Diff line change
@@ -98,20 +98,19 @@ The available fields are:
98
98
- For the `packer` asset type, this must point to the path where the `txt` and `png` are located, without the file extension.
99
99
- For the `animateatlas` asset type, this must point to the folder where the `Animation.json` and any spritemaps are located.
100
100
- For the `multisparrow` asset type, point to the path where your main Sparrow spritesheet is located. On each animations which uses a different Sparrow spritesheet from the main one, add the `assetPath` key to that specific animation.
101
-
-`scale`: Specify the size of the character relative to the original size. For example, `2.0` makes the sprite twice as big. Optional, defaults to `1.0`.
102
-
-`healthIcon`: Data for the health icon to display in-game. For example, Boyfriend will obviously use Boyfriend's health icon.
103
-
-`death`: Data for the death screen to use, when the character reaches `0` health.
104
-
-`offsets`: The global offset to the character's position, in pixels.
101
+
-`scale`*(currently buggy)*: Specify the size of the character relative to the original size. For example, `2.0` makes the sprite twice as big. Optional, defaults to `1.0`.
102
+
-`healthIcon`: Data for the health icon to display in-game. For example, Boyfriend will obviously use Boyfriend's health icon. Optional, defaults its ID to character's ID.
103
+
-`death`: Data for the death screen to use, when the character reaches `0` health. Optional, doesn't default to a specific object.
104
+
-`offsets`: The global offset to the character's position, in pixels. Optional, defaults to `[0, 0]`.
105
105
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
106
-
-`cameraOffsets`: The amount to offset the camera by while focusing on this character.
107
-
- Default value focuses on the character directly.
106
+
-`cameraOffsets`: The amount to offset the camera by while focusing on the character. Optional, default value focuses on the character directly.
108
107
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
109
-
-`isPixel`: Specify whether to disable texture smoothing for this character. Optional, defaults to `false`.
108
+
-`isPixel`: Specify whether to disable texture smoothing for the character. Optional, defaults to `false`.
110
109
-`danceEvery`: The frequency at which the character will play its idle animation, in beats. Optional, defaults to `1`.
111
110
- Increasing this number will make the character dance less often.
112
-
-`flipX`: Whether to flip the whole sprite horizontally in-game. Useful for characters that could also be played (Pico).
113
-
-`startingAnimation`: The animation for the character to play when they are first loaded in.
114
-
-`singTime`: The amount of time, in steps, for a character to keep singing after they let go of a note.
111
+
-`flipX`: Whether to flip the whole sprite horizontally in-game. Useful for characters that could also be played (Pico). Optional, defaults to `false`.
112
+
-`startingAnimation`: The animation for the character to play when they are first loaded in. Optional, defaults to `idle`.
113
+
-`singTime`: The amount of time, in steps, for a character to keep singing after they let go of a note. Optional, defaults to `8`.
115
114
- Decrease this if the character seems to hold their poses for too long after their section is done.
116
115
- Increase this if the character resets to the idle animation in the middle of their singing animations.
117
116
-`animations`: A list of animation data objects for the character.
0 commit comments