Documentation Index
Fetch the complete documentation index at: https://mintlify.com/toxicity188/BetterModel/llms.txt
Use this file to discover all available pages before exploring further.
The BoneName record represents a parsed bone name with associated tags. It’s used throughout BetterModel to identify and filter bones based on their naming conventions.
Package: kr.toxicity.model.api.bone
Type: Record
Since: 1.0.0
Record Components
public record BoneName(
@NotNull @Unmodifiable Set<BoneTag> tags,
@NotNull String name,
@NotNull String rawName
)
Components
- tags - The set of tags extracted from the raw name (e.g.,
#hitbox, #head)
- name - The clean name without tags
- rawName - The original unparsed name string
Creation
Parsing from String
public static BoneName of(String rawName)
BoneName instance. Tags are extracted based on the configured tag registry.
Example:
// Parse bone name with tags
BoneName boneName = BoneName.of("#hitbox#interactive.head");
System.out.println(boneName.name()); // "head"
System.out.println(boneName.rawName()); // "#hitbox#interactive.head"
System.out.println(boneName.tags().size()); // 2
JSON Deserialization
public static final JsonDeserializer<BoneName> PARSER
{
"bone": "#weapon.sword_blade"
}
Tag Management
public boolean tagged(BoneTag... tags)
BoneName boneName = BoneName.of("#hitbox#head.skull");
if (boneName.tagged(BoneTag.of("hitbox"))) {
System.out.println("This bone should have a hitbox");
}
if (boneName.tagged(
BoneTag.of("hitbox"),
BoneTag.of("interactive")
)) {
System.out.println("This bone has at least one of these tags");
}
public BoneItemMapper toItemMapper()
BoneItemMapper.EMPTY if no tags specify a mapper.
Example:
BoneName boneName = BoneName.of("#left_hand.item");
BoneItemMapper mapper = boneName.toItemMapper();
// Use mapper for item transformation
TransformedItemStack stack = mapper.apply(context, itemStack);
Common Tag Patterns
BetterModel uses tags to define special behaviors for bones:
#left_hand - Display as left-hand item#right_hand - Display as right-hand item#head - Display as head/helmet item
#hitbox - Should create a hitbox#interactive - Interactive element#mount - Mountable bone
Example Usage
// Create bones with specific behaviors
BoneName weapon = BoneName.of("#right_hand.sword");
BoneName helmet = BoneName.of("#head.crown");
BoneName hitbox = BoneName.of("#hitbox.body");
// Filter bones by tags
renderedBone.flatten()
.filter(bone -> bone.name().tagged(BoneTag.of("hitbox")))
.forEach(bone -> {
// Create hitboxes for all tagged bones
bone.createHitBox(entity, b -> true, listener);
});
Equality and Hashing
Bone names are compared based on their rawName field:
@Override
public boolean equals(Object o)
@Override
public int hashCode()
BoneName bone1 = BoneName.of("#hitbox.head");
BoneName bone2 = BoneName.of("#hitbox.head");
BoneName bone3 = BoneName.of("#interactive.head");
System.out.println(bone1.equals(bone2)); // true
System.out.println(bone1.equals(bone3)); // false
String Representation
@Override
public String toString()
BoneName boneName = BoneName.of("#hitbox#weapon.sword");
System.out.println(boneName.toString()); // "#hitbox#weapon.sword"
Naming Conventions
When naming bones in your 3D modeling software:
- Use descriptive names:
head, left_arm, weapon
- Add tags with
# prefix: #hitbox.body, #left_hand.item
- Use dot notation for hierarchy:
armor.helmet, weapon.blade
- Combine multiple tags:
#hitbox#interactive.door
Example bone hierarchy:
player_model
├── #head.head
├── body
│ └── #hitbox.torso
├── #left_hand.left_arm
│ └── hand
└── #right_hand#weapon.right_arm
└── sword_blade
See Also
