Objects and Tags

---

BMEntityTag

Represents an entity that has one or more BetterModel models attached to it.

• Prefix: bmentity
• Format: The identity format is the UUID of the base entity (e.g., bmentity@dfc67056-b15d-45dd-b239-482d92e482e5).
• Tags:
• <EntityTag.bm_entity>: Returns the BMEntityTag of the entity, if it has any BetterModel models. It returns null if the entity has no models.
• <BMEntityTag.base_entity>: Returns the base Bukkit entity as an EntityTag.
• <BMEntityTag.model[(<model_name>)]>: Returns the BMModelTag for the specified model name on the entity. If no name is provided, it returns the first model loaded on the entity.

BMModelTag

Represents a specific model instance attached to an entity.

• Prefix: bmmodel

• Format: The identity format is <uuid>,<model_name> (e.g., bmmodel@dfc67056-b15d-45dd-b239-482d92e482e5,dummy).

• Tags:

• <BMModelTag.name>: Returns the name of the model.

• <BMModelTag.bm_entity>: Returns the parent BMEntityTag of this model.

• <BMModelTag.bones>: Returns a MapTag of all bones in the model, with the bone name as the key and the BMBoneTag as the value.

• <BMModelTag.bone[<name>]>: Returns the BMBoneTag for the bone with the specified name from the model.

• <BMModelTag.get_animation_duration[<name>]>: Returns the total duration of the specified animation.

• <BMModelTag.animations>: Returns a ListTag of all available animation names for this model.

• Mechanisms:

• force_update Forces an immediate visual update of the model for all viewers.

BMBoneTag

Represents a single bone within a specific model instance on an entity.

• Prefix: bmbone

• Format: <uuid>,<model_name>,<bone_name> (e.g., bmbone@dfc67056-b15d-45dd-b239-482d92e482e5,dummy,head)

• Tags:

• <BMBoneTag.name>: Returns the bone's name (ElementTag).

• <BMBoneTag.world_location>: Returns the bone's world position (LocationTag).

• <BMBoneTag.world_rotation_euler>: Returns the bone's precise, real-time rotation in world space as Euler angles (LocationTag).

• <BMBoneTag.local_position>: Returns the bone's position relative to the model/entity origin (LocationTag).

• <BMBoneTag.global_position>: Returns the bone's absolute location calculated from the model offset (LocationTag).

• <BMBoneTag.real_position>: Returns the calculated real-world location of the bone, taking into account the entity's body rotation (Pitch/Yaw) (LocationTag).

• <BMBoneTag.is_visible>: Returns whether the bone is visible (ElementTag(Boolean)).

• <BMBoneTag.bm_model>: Returns the parent model (BMModelTag).

• Mechanisms:

• tint:<ElementTag(Integer)> Applies an RGB color tint to the bone's item. (<ColorTag.rgb_integer>)

• scale:<LocationTag> Sets the scale vector of the bone.

• visible:<ElementTag(Boolean)> or ListTag Sets visibility. Can be a simple boolean, or a ListTag where the first element is a boolean and subsequent elements are PlayerTags to apply the visibility only to specific players.

• item:<ItemTag> Sets the item displayed by the bone.

• offset:<LocationTag> Sets the local offset of the bone's item.

• rotate:<QuaternionTag> Applies an additional rotation to the bone.

• view_range:<ElementTag(Decimal)> Sets the render distance for the bone in blocks.

• interpolation_duration:<DurationTag> Sets the movement interpolation duration for the bone.

• glow:<ElementTag(Boolean)> Enables or disables glowing effect for the bone.

• glow_color:<ElementTag(Integer)> Sets the RGB glow color.

• brightness:<ListTag(Integer)> Sets the brightness level for the bone. Requires a ListTag of two integers: block_light|sky_light.

• shadow_radius:<ElementTag(Decimal)> Sets the shadow radius of the bone display.

• billboard:<ElementTag> Sets the billboard render mode. Values: FIXED, VERTICAL, HORIZONTAL, CENTER.

PlayerTag

Extensions to the PlayerTag for accessing BetterModel player-specific animations (Limbs).

• Tags:
• <PlayerTag.limb[(<model_name>)]>: Returns a MapTag containing details (animation_name, loop_mode) of the currently active animation for the specified limb model. If no model name is specified, it checks the first available tracker.
• <PlayerTag.limb_bones[<model_name>]>: Returns a MapTag of all bones for a specific player limb model, where keys are bone names and values are BMBoneTag objects. Requires the model name.