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
{{ message }}
Repository navigation
Commit fb5caa6
Browse filesBrowse the repository at this point in the historyBrowse files
description: Configure loop behavior, timing, and node exclusions for an animation.
3
+
description: Configure loop behavior, timing, node exclusions, and previews for an animation.
4
4
---
5
5
6
-
The Animation Properties dialog controls how a single animation behaves at runtime.
6
+
#Animation Config
7
7
8
-
In Blockbench, open it by right-clicking an animation in the Animations panel and selecting Animation Properties.
8
+
The **Animation Properties** dialog controls how one animation behaves. Open it by right-clicking an animation in the **Animations** panel and choosing **Properties**.
9
9
10
-
## Why It Matters
10
+
## Fields
11
11
12
-
Animated Java uses these fields to generate per-animation metadata and runtime behavior.
12
+
### Animation Name
13
13
14
-
- Loop behavior decides what happens when the animation reaches the last frame.
15
-
- Timing fields control how quickly the animation advances.
16
-
- Excluded Nodes lets you layer multiple animations without bone conflicts.
17
-
18
-
## Fields In The Dialog
19
-
20
-
### Name
21
-
22
-
The animation identifier used in generated function paths and storage keys.
23
-
24
-
- Keep names stable after publishing packs to avoid breaking function calls.
25
-
- Use only safe characters: letters, numbers, underscore, and dot.
26
-
27
-
Example generated path:
14
+
The animation's name, used in its function paths and tags:
28
15
29
16
```mcfunction
30
17
<blueprint_id>/animations/<animation_name>/play
31
18
```
32
19
33
-
### Loop Mode
20
+
Names may only use letters, digits, underscores, and periods. When exported, they're lowercased and periods become `_`.
34
21
35
-
Controls behavior at the end of the timeline.
22
+
:::warning
23
+
Renaming an animation changes its function paths. Update any commands that call it.
24
+
:::
36
25
37
-
- once: play to the end, then stop.
38
-
- hold: play to the end and remain on the last frame.
39
-
- loop: return to frame 0 and continue.
26
+
### Loop Mode
40
27
41
-
Use hold for poses (for example, aiming or charging) and loop for cycles (walk, idle, run).
28
+
What happens when the animation reaches its last frame:
29
+
30
+
-**Once**: stop, and snap back to the first frame.
31
+
-**Hold**: stop, and stay on the last frame.
32
+
-**Loop**: start over from the first frame.
42
33
43
34
### Loop Delay
44
35
45
-
Extra delay in ticks before a looping animation restarts.
36
+
How many ticks to wait before a **Loop** animation starts over. `20` ticks is one second. Has no effect on the other loop modes.
46
37
47
-
- Only applies when Loop Mode is loop.
48
-
- 20 ticks = 1 second.
38
+
### Excluded Nodes
49
39
50
-
### Included / Excluded Nodes
40
+
Nodes this animation never moves. Drag nodes between the **Included Nodes** and **Excluded Nodes** columns, or use the swap button to flip the two lists.
51
41
52
-
A list of bones (groups) this animation should or should not modify.
42
+
Use it to:
53
43
54
-
This is one of the most important controls for advanced rigs.
44
+
- play an upper-body animation while the legs keep walking,
45
+
- run a facial animation alongside body animations,
46
+
- stop two animations from fighting over the same node.
55
47
56
-
Use it to:
48
+
Excluded nodes also aren't updated at all, which saves performance.
49
+
50
+
### Preview Variants
51
+
52
+
The [Variants](/docs/core-concepts/variants) shown when you preview this animation in the editor, applied in order. Set these to the state the rig will usually be in when the animation plays. Empty means the Default Variant.
53
+
54
+
Only affects the editor.
57
55
58
-
- play an upper-body animation while legs continue walking,
59
-
- run facial animation alongside body motion,
60
-
- avoid two animations fighting over the same bones.
56
+
### Preview Texture Slots
61
57
62
-
## Practical Patterns
58
+
The textures [Texture Slots](/docs/core-concepts/texture-slots) show when you preview this animation, applied after the Preview Variants. Empty means the slots show whatever the Preview Variants set.
63
59
64
-
### Layered locomotion + action
60
+
Only affects the editor.
65
61
66
-
- Walk animation: exclude arm and head bones used by combat.
67
-
- Attack animation: exclude leg and root locomotion bones.
62
+
## Patterns
68
63
69
-
Result: both can run at the same time without overriding each other.
64
+
### Layered locomotion and actions
70
65
71
-
### Pose locking
66
+
-`walk` excludes the arm and head bones.
67
+
-`attack` excludes the leg bones.
72
68
73
-
- Set Loop Mode to hold for a final pose.
74
-
- Trigger a second animation later to exit the pose cleanly.
69
+
Both can play at the same time without overriding each other.
75
70
76
-
##Common Mistakes
71
+
### Holding a pose
77
72
78
-
- Renaming animations after datapack integration without updating all function calls.
79
-
- Forgetting Excluded Nodes, causing bone conflicts and jitter.
80
-
- Setting Loop Delay and expecting it to affect once or hold modes.
81
-
- Overcomplicating Molang fields when default timing already works.
73
+
- Set an `aim` animation to **Hold**, so the rig stays aimed.
74
+
-[Tween](/docs/function-api/animations#tween) into another animation to leave the pose smoothly.
82
75
83
76
## Related Reading
84
77
85
78
-[Animations](/docs/core-concepts/animations)
86
-
-[Animations Function API](/docs/function-api/animations)
87
-
-[Groups](/docs/nodes/groups)
88
-
-[Your First Blueprint](/docs/getting-started/your-first-blueprint)
Copy file name to clipboardExpand all lines: src/docs/configs/display-entity/en.md
+40-90Lines changed: 40 additions & 90 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,128 +3,78 @@ title: Display Entity Config
3
3
description: Configure how Groups, Item Displays, Block Displays, and Text Displays behave at runtime.
4
4
---
5
5
6
-
The Display Entity Config controls properties for rendered display entities.
6
+
#Display Entity Config
7
7
8
-
You can open it from the outliner context menu on supported nodes:
8
+
The Display Entity Config controls the in-game settings of a node's display entity. Open it by right-clicking a node in the Outliner and choosing **Display Entity Config**. It's available on:
9
9
10
-
- Groups
11
-
- Item Displays
12
-
- Block Displays
13
-
- Text Displays
10
+
-[Groups](/docs/nodes/groups) that contain Cubes,
11
+
-[Item Displays](/docs/nodes/item-displays),
12
+
-[Block Displays](/docs/nodes/block-displays),
13
+
-[Text Displays](/docs/nodes/text-displays).
14
14
15
-
## What This Config Affects
15
+
The dialog has two pages: **General** settings that never change, and **Per-Variant** settings that can be different for each [Variant](/docs/core-concepts/variants).
16
16
17
-
This dialog stores two kinds of settings:
17
+
## General
18
18
19
-
- Node-level settings
20
-
- Per-variant settings
19
+
-#### On-Summon Function
21
20
22
-
### Node-level settings
21
+
Commands that run `as` the node's entity when the rig is summoned. Supports [MC-Build](https://mcbuild.dev) syntax.
23
22
24
-
These are stored once on the node:
23
+
## Per-Variant
25
24
26
-
-On Summon Function
25
+
-#### Target Variant
27
26
28
-
### Per-variant settings
27
+
Which Variant you're editing settings for. **Default** sets the node's base settings. Any other Variant sets what the node changes to when that Variant is applied.
29
28
30
-
These are selected using the variant dropdown in the dialog and can differ per variant:
29
+
-#### On-Apply Function
31
30
32
-
- On Apply Function
33
-
- Billboard
34
-
- Brightness override settings
35
-
- Enchanted (not available on Text Displays)
36
-
- Glowing (not available on Text Displays)
37
-
- Glow color override (not available on Text Displays)
38
-
- Shadow settings
31
+
Commands that run `as` the node's entity when the Target Variant is applied.
39
32
40
-
## Field Reference
33
+
-#### Billboard
41
34
42
-
### On Summon Function
35
+
Whether the entity turns to face the player:
43
36
44
-
Runs when the rig is summoned for that node.
37
+
-**Fixed**: never turns.
38
+
-**Vertical**: turns around the vertical axis.
39
+
-**Horizontal**: turns around the horizontal axis.
40
+
-**Center**: turns around both axes.
45
41
46
-
Use this for setup commands that should happen once when the node entity is created.
42
+
-#### Override Brightness
47
43
48
-
### Variant Selector
44
+
Ignores the world's lighting and uses fixed **Sky Brightness** and **Block Brightness** values instead, each from `0` to `15`.
49
45
50
-
Selects which variant you are editing config for.
46
+
-#### Enchanted
51
47
52
-
- Default writes to the node default display config.
53
-
- Other entries write per-variant overrides.
48
+
Adds the enchantment glint. Not available on Block Displays or Text Displays.
54
49
55
-
###On Apply Function
50
+
-#### Glowing
56
51
57
-
Runs when that variant is applied and this node has a config override for that variant.
52
+
Gives the entity a glowing outline. Not available on Text Displays.
58
53
59
-
Use this for variant-specific command logic.
54
+
-#### Override Glow Color
60
55
61
-
### Billboard
56
+
Overrides the color of the glowing outline. Not available on Text Displays.
62
57
63
-
Controls how the display entity faces the viewer:
58
+
-#### Shadow Radius
64
59
65
-
- Fixed: no billboard pivoting
66
-
- Vertical: pivots on vertical axis
67
-
- Horizontal: pivots on horizontal axis
68
-
- Center: pivots around center
60
+
The radius of the entity's shadow.
69
61
70
-
###Override Brightness
62
+
-#### Shadow Strength
71
63
72
-
Enables explicit light override for the node.
64
+
How dark the entity's shadow is.
73
65
74
-
When enabled, two values are used:
66
+
## How Per-Variant Settings Apply
75
67
76
-
- Sky Brightness: 0 to 15
77
-
- Block Brightness: 0 to 15
68
+
- Applying a Variant applies its settings to every node that has them, and runs their On-Apply functions.
69
+
- Nodes without settings for a Variant keep whatever they had before.
70
+
- Applying the Default Variant restores every node's Default settings.
78
71
79
-
### Enchanted
72
+
##Copying Settings
80
73
81
-
Adds the enchanted glint to applicable display entities.
82
-
83
-
This option is not available for Text Displays.
84
-
85
-
### Glowing
86
-
87
-
Enables vanilla glowing effect for applicable display entities.
88
-
89
-
This option is not available for Text Displays.
90
-
91
-
### Override Glow Color
92
-
93
-
If enabled, sets a custom glow color using Glow Color.
94
-
95
-
This option is not available for Text Displays.
96
-
97
-
### Glow Color
98
-
99
-
Hex color used when Override Glow Color is enabled.
100
-
101
-
### Shadow Radius
102
-
103
-
Controls shadow radius. Slider range in the dialog is 0 to 15.
104
-
105
-
### Shadow Strength
106
-
107
-
Controls shadow strength. Slider range in the dialog is 0 to 15.
108
-
109
-
## Important Behavior Notes
110
-
111
-
- Per-variant settings are only applied when variant logic runs.
112
-
- If a variant has no override for a node, the node keeps its current/default display config.
113
-
- The Invisible flag exists internally in config data but is not currently exposed in this dialog UI.
114
-
115
-
## Copy/Paste Config
116
-
117
-
The context menu also includes:
118
-
119
-
- Copy Display Entity Config
120
-
- Paste Display Entity Config
121
-
122
-
This copies On Summon Function and all display config data from one supported node to another.
74
+
The node's context menu also has **Copy Display Entity Config** and **Paste Display Entity Config**. They copy the On-Summon Function and every per-Variant setting from one node to another.
description: Tint a bone's faces in-game with vanilla tint sources.
4
+
---
5
+
6
+
# Item Model Properties
7
+
8
+
Item Model Properties control how a bone's faces are **tinted** in-game. A tint multiplies a face's texture by a color, which lets you recolor parts of a rig without making new textures. For example, you could tint a shirt with the color of the player's team, or a potion bottle with its potion's color.
9
+
10
+
Open it by right-clicking a [Group](/docs/nodes/groups) that contains Cubes and choosing **Item Model Properties**. Requires **Minecraft 1.21.4 or newer**.
11
+
12
+
## How Tints Work
13
+
14
+
1. In Blockbench, set the **Tint** of the faces you want to recolor to a tint index (`0`, `1`, `2`, …) in the face properties of the UV panel.
15
+
2. In Item Model Properties, add one tint per index. The first tint in the list is index `0`, the second is index `1`, and so on.
16
+
17
+
Faces without a tint index are never tinted.
18
+
19
+
If a bone has no tints configured, Animated Java gives it a white **Dye** tint at index `0`. Faces with tint index `0` can then be recolored in-game by setting the bone item's `minecraft:dyed_color` component.
20
+
21
+
## Tint Types
22
+
23
+
Each tint has a **Type**. Click a tint to show its settings.
|**Firework**| The colors of the item's firework explosion component. |
30
+
|**Potion**| The color of the item's potion contents. |
31
+
|**Map Color**| The item's map color component. Not available in Minecraft 26.3 and newer. |
32
+
|**Team**| The team color of the entity displaying the item. |
33
+
|**Grass**| The grass colormap, at a set **Temperature** and **Downfall** (each `0` to `1`). |
34
+
|**Custom Model Data**| An entry in the item's `custom_model_data` colors list, picked by **Index**. |
35
+
36
+
Every type except Constant and Grass also has a **Default Color**, used when the item doesn't have the component (or, for Team, when the entity isn't on a team with a color).
37
+
38
+
:::note[Transparency]
39
+
Alpha only works on **Dye** and **Firework** tints, and only because of a vanilla bug ([MC-278626](https://bugs.mojang.com/browse/MC-278626)). It may stop working in a future Minecraft version. With cutout textures, faces below about 10% alpha disappear, and the rest render fully opaque.
40
+
:::
41
+
42
+
If your Target Minecraft Version doesn't support a tint's type, the dialog warns you, and exporting fails until you change or remove it.
0 commit comments