Model Engine 4

https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/
Admin
Model Engine 4 is a powerful tool for creating, animating, importing, and managing custom 3D models...
Tokens:32,335
Snippets:476
Trust Score:8.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### VFX Mechanic Example 1

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/MythicMobs/mechanics/vfx/_template

Basic implementation template for a VFX mechanic.

```yaml
Skills:
  - yml
  - yml
  - yml
```

--------------------------------

### Mount and Dismount Model Example

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/DismountModel

Demonstrates mounting a player to a specific bone on interaction and dismounting them when the mob takes damage.

```yaml
Skills:
  - model{m=elk;usm=true;drive=true;ride=true;n=nametag} @self ~onSpawn
  - mountmodel{mid=elk;d=false;p=seat2} @trigger ~onInteract
  # Dismount when the mob takes damage
  - dismountmodel{m=elk;p=seat2} @self ~onDamaged
```

--------------------------------

### Model Mechanic Example 1

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/MythicMobs/mechanics/model/_template

Basic YAML configuration template for a model mechanic.

```yaml

```

--------------------------------

### Toggle Model State with StateToggle

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/StateToggle

This example demonstrates how to toggle the 'activated' state on a model when a player interacts with it.

```yaml
  Skills:
  - StateToggle{mid=ExampleModel;state=activated} @self ~onInteract
```

--------------------------------

### ModelHasDriver Configuration Examples

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Conditions/ModelHasDriver

Demonstrates setting up a mob to use the condition and defining the corresponding skill logic for mount and dismount events.

```yaml
# MOB CONFIG
ExampleMob:
  Type: DROWNED
  Skills:
  - model{mid=your_model} @self ~onSpawn
  - skill:MountEventManager @self ~onTimer:5
```

```yaml
# SKILL CONFIG
MountEventManager:
  Conditions:
  - modelhasdriver true
  Skills:
  - aura{
    auraName=MountEventManager;
    d=6;
    onStart=MountEventManager_MountEvent;
    onEnd=MountEventManager_DismountEvent
    } @self

MountEventManager_MountEvent:
  Skills:
  - message{m="you mounted the entity"}

MountEventManager_DismountEvent:
  Skills:
  - message{m="you dismounted the entity"}
```

--------------------------------

### HitboxIsSubHitbox YAML Configuration

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Conditions/HitboxIsSubHitbox

Example usage of the HitboxIsSubHitbox condition within a skill configuration.

```yaml
  Conditions:
  - HitboxIsSubHitbox{hb=mycustomhitbox} true
```

--------------------------------

### Set VFX Brightness Example

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/VFXBrightness

Applies a VFX with maximum block light and zero sky light using the vfxbrightness mechanic.

```yaml
Skills:
  - skill{s=[
    - vfx{mid=weapon_vfx;pid=fire_bolt}
    - vfxbrightness{block=15;sky=0}
    ]} @self ~onSpawn
```

--------------------------------

### Move forward mechanic example

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/Move

Forces the entity to move forward at double the standard movement speed.

```yaml
Skills:
  - move{z=1;speed=2} @self
```

--------------------------------

### ChangeParent Mechanic Usage

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/ChangeParent

Example of spawning a model and re-parenting a bone using the changeparent mechanic.

```yaml
Skills:
  - model{m=Duck} @self ~onSpawn
  - changeparent{m=Duck;p=body;c=right_leg}
```

--------------------------------

### Showing a model with RenderInit

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/RenderInit

Demonstrates applying a model on spawn with initrender disabled, performing customizations, and then revealing the model.

```yaml
Skills:
  - model{mid=testmodel;initrender=false} @self ~onSpawn
  # Customize the model further
  - tint{mid=testmodel;color=ff0000} @self ~onSpawn
  - enchant{mid=test} @self ~onSpawn
  # Finally, show the model
  - renderinit{mid=testmodel} @self ~onSpawn
```

--------------------------------

### Creating a Dummy

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Per-Player-Model

Initializes a new dummy entity and attaches a model to it.

```APIDOC
## Creating a Dummy

### Description
Creates a new dummy entity and assigns a model to it. Setting detecting players to false disables automatic spawning/despawning behavior.

### Usage
```java
Dummy<?> dummy = new Dummy<>();
dummy.setDetectingPlayers(false);
ModeledEntity modeledEntity = ModelEngineAPI.createModeledEntity(dummy);
ActiveModel activeModel = ModelEngineAPI.createActiveModel("test_model");
modeledEntity.addModel(activeModel, true);
```
```

--------------------------------

### State Command Syntax

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Citizens/Commands-and-Permissions

Syntax for managing model animations on a Citizens NPC.

```text
/meg npc state [npc-id] [model-id] [add/remove] [animation] <lerp-in=0> <lerp-out=0> <speed=1>
```

--------------------------------

### Heal Model Driver Example

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Targeters/ModelDriver

Demonstrates using the @modeldriver targeter to heal the driver of a modeled entity, conditional on the model having a driver.

```yaml
ExampleSkill:
  Conditions:
  - modelhasdriver true
  Skills:
  - heal{a=10} @modeldriver
```

--------------------------------

### Create a Dummy Entity

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Per-Player-Model

Initializes a dummy entity and attaches a model to it, disabling automatic player detection.

```java
Dummy<?> dummy = new Dummy<>();
// The dummy will no longer spawn and despawn for players automatically
dummy.setDetectingPlayers(false);
ModeledEntity modeledEntity = ModelEngineAPI.createModeledEntity(dummy);
ActiveModel activeModel = ModelEngineAPI.createActiveModel("test_model");
modeledEntity.addModel(activeModel, true);
```

--------------------------------

### Implementing a BlockbenchBehaviorParser

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Bone-Behaviors

Create a parser to extract configuration from model bones and register behaviors based on bone names.

```java
public class GlowBehaviorParser implements BlockbenchBehaviorParser {

    @Override
    public void processModel(ErrorCollector collector, BlockbenchModel model, ModelBlueprint blueprint) {
        // Optional: whole-model parsing. Leave empty if unused.
    }

    @Override
    public void processBone(ErrorCollector collector, BlockbenchModel model, BlockbenchModel.Group group, BlueprintBone bone) {
        // Attach the "glow" behavior to bones whose name starts with "glow_"
        if (bone.getName().startsWith("glow_")) {
            var options = new HashMap<String, Object>();
            options.put("enabled", true);
            bone.getBehaviors().put("glow", options);
        }
    }

}
```

--------------------------------

### Implement BehaviorRenderer

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Render-Type

Provides the core rendering logic, including initialization, data reading, packet sending, and destruction.

```java
public class CustomRenderer implements BehaviorRenderer {

	private final ActiveModel activeModel;
	private ModelRenderer modelRenderer;

	public CustomRenderer(ActiveModel activeModel) {
		this.activeModel = activeModel;
	}

	@Override
	public ModelRenderer getModelRenderer() {
		return modelRenderer;
	}

	@Override
	public void setModelRenderer(ModelRenderer renderer) {
		this.modelRenderer = renderer;
	}

	@Override
	public ActiveModel getActiveModel() {
		return activeModel;
	}

	@Override
	public void initialize() {
		// Set up state once when the renderer is created
	}

	@Override
	public void readBoneData() {
		// Pull the latest transforms / values from the bone each tick
	}

	@Override
	public void sendToClient(RenderParsers parsers) {
		// Build and send packets through the supplied parsers
	}

	@Override
	public void destroy(RenderParsers parsers) {
		// Tear down / remove any spawned entities
	}

}
```

--------------------------------

### Timeline Construction

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Initializes a new Timeline associated with a BlueprintAnimation.

```APIDOC
## Timeline(BlueprintAnimation animation, boolean globalRotation)

### Description
Creates a new timeline instance for a specific animation.

### Parameters
- **animation** (BlueprintAnimation) - Required - The animation this timeline belongs to.
- **globalRotation** (boolean) - Required - Whether rotation keyframes are in global model space.
```

--------------------------------

### Model Command Syntax

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Citizens/Commands-and-Permissions

Syntax for adding or removing models from a Citizens NPC.

```text
/meg npc model [npc-id] [add/remove] [model-id] <show-base-entity=false> <override-hitbox=true>
```

--------------------------------

### Register a Custom Controller

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Mount-Controller

Register the controller with the MountControllerTypeRegistry during plugin startup to enable compatibility with MythicMobs.

```java
// On plugin start-up
ModelEngineAPI.getMountControllerTypeRegistry().register("custom_controller", CustomMountController.CUSTOM);
```

--------------------------------

### Construct a Timeline

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Initialize a new timeline associated with a BlueprintAnimation.

```java
// animation: the BlueprintAnimation this timeline belongs to
// globalRotation: whether rotation keyframes are in global (model) space
Timeline timeline = new Timeline(blueprintAnimation, false);
```

--------------------------------

### Apply temporary model states

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/DefaultState

Demonstrates using the defaultstate mechanic within an aura skill to toggle between walk and run animations based on damage events.

```yaml
  Skills:
  - aura{d=100;name=running;
    onStart=[
    - defaultstate{mid=ExampleModel;type=walk;state=run}
    ];
    onEnd=[
    - defaultstate{mid=ExampleModel;type=walk;state=walk}
    ]} @self ~onDamaged
```

--------------------------------

### Implement Custom Attack Animation

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/FAQ

Use these MythicMobs skill configurations to cancel the default attack event, play a custom animation state, and apply damage after a specific delay.

```yaml
ExampleMob:
  Type: ZOMBIE
  Skills:
  - model{mid=examplemob} @self ~onSpawn
  - skill{s=ExampleModelAttack;sync=true} @self ~onAttack
```

```yaml
ExampleModelAttack:
  Skills:
  - cancelevent
  - state{...}
  - delay 17
  - damage{...} @trigger
```

--------------------------------

### Toggle Root Motion Override

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/RootMotion

Demonstrates enabling and disabling the root motion override within a skill sequence.

```yaml
  Skills:
  - rootmotion{ov=true}
  - state{s=animation}
  - delay 100
  - rootmotion{ov=false}
```

--------------------------------

### Basic MountModel Usage

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/MountModel

Mounts the trigger entity to a model upon interaction. Requires a model with a defined mount bone.

```yaml
Skills:
  - model{m=elk;usm=true;drive=true;ride=true;n=nametag} @self ~onSpawn
  - mountmodel{mid=elk;m=walking} @trigger ~onInteract
```

--------------------------------

### Register event listener on plugin startup

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Importer

Registers the listener class with the Bukkit plugin manager during startup.

```java
// On plugin start-up
getServer().getPluginManager().registerEvents(new ParserListener(), this);
```

--------------------------------

### Implement a Custom Mount Controller

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Mount-Controller

Extend AbstractMountController to define custom movement logic for drivers and passengers. Ensure the MountControllerType is not stored as a static instance.

```java
public class CustomMountController extends AbstractMountController {

	// Type class used to specify the controller when mounting entity
	// NEVER SUPPLY A STATIC INSTANCE
	public static final MountControllerType CUSTOM = new MountControllerType(CustomMountController::new);

	public CustomMountController(Entity entity, Mount mount) {
		super(entity, mount);
	}

	@Override
	public void updateDriverMovement(MoveController controller, ActiveModel model) {
		// Update function for driver
	}

	@Override
	public void updatePassengerMovement(MoveController controller, ActiveModel model) {
		// Update function for passengers
	}

}
```

--------------------------------

### MountModel with Meta Controller

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/MountModel

Mounts the trigger entity using a Meta Controller to define custom movement and interaction logic. Requires MythicMobs Premium.

```yaml
Skills:
  - model{m=elk;usm=true;drive=true;ride=true;n=nametag} @self ~onSpawn
  - mountmodel{mode=[
      - move{front=<skill.var.meg:front>;side=<skill.var.meg:side>}
      - meg:jump ?variableEquals{var=skill.meg:jump;value=1} ?variableEquals{var=skill.meg:on_ground;value=1}
      - dismountmodel @trigger ?variableEquals{var=skill.meg:sneak;value=1}
      - actionmessage{m=<skill.var.meg:front> <skill.var.meg:side> <skill.var.meg:jump> <skill.var.meg:sneak>} @trigger
    ]} @trigger ~onInteract
```

--------------------------------

### Registering the Listener

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Bone-Behaviors

Register the listener class in the plugin's startup logic to ensure the parser is hooked correctly.

```java
Bukkit.getPluginManager().registerEvents(new BehaviorParserListener(), plugin);
```

--------------------------------

### Set skin using Base64 texture data

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/ModelPlayerSkin

Applies a skin directly from Base64 encoded texture data.

```yaml
Skills:
  - model{m=skin} @self ~onSpawn
  - modelplayerskin{skin=e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjNhOTY0Y2I3ZTM2Yzc2NzM4ODY1ZjhjYzdmZGRmZTQ5MDYwOWUxZDdkZTQ5NTlkN2I1NzZlYmQxYjZmZjBhIn19fQ==} @self ~onSpawn
```

--------------------------------

### Mounting a Driver to a Model

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Mounting-Dismounting-Model

Mounts an entity as a driver to the model using a specific movement controller.

```java
ActiveModel model = ...
model.getMountManager().ifPresent(mountManager -> {
	mountManager.mountDriver(entity, MountControllerTypes.WALKING);
});
```

--------------------------------

### ChangePart Mechanic Usage

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/ChangePart

Demonstrates swapping the left arm of one model with the left arm of another model.

```yaml
ApplyModel:
  Skills:
  - model{mid=kindletronjr} @self
  - changepart{mid=kindletronjr;pid=left_arm;nmid=kindletronsr;npid=left_arm} @self
```

--------------------------------

### Model Engine Bukkit Events Reference

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Events

A summary of available Bukkit events provided by Model Engine, including their purpose and cancelability.

```APIDOC
## Model Engine Bukkit Events

### Description
Model Engine provides several events for developers to interact with the model lifecycle, custom parsers, and entity behaviors.

### Events List
| Event | Description | Cancelable |
| :--- | :--- | :--- |
| ModelRegistrationEvent | Fired when the model generator enters/exits a phase or finishes. | No |
| RegisterParserEvent | Fired during startup to register custom model importers. | Yes |
| RegisterBehaviorParserEvent | Fired during startup to register custom bone behavior parsers. | Yes |
| AddModelEvent | Fired when a model is about to be added to a Modeled Entity. | Yes |
| ModelSetupEvent | Fired after a model has been set up on a Modeled Entity. | No |
| RemoveModelEvent | Fired when a model is about to be removed from a Modeled Entity. | Yes |
| ModelMountEvent | Fired when an entity mounts on an Active Model. | Yes |
| ModelDismountEvent | Fired when an entity dismounts from an Active Model. | Yes |
| AnimationPlayEvent | Fired when an animation is about to be played by an Active Model. | Yes |
| AnimationEndEvent | Fired when an animation ends. | No |
| BoneTransformReadEvent | Fired when a bone's transform is read, allowing modification of position, rotation, and scale. | No |
| BaseEntityInteractEvent | Fired when a model is being attacked or interacted with. | No |
```

--------------------------------

### Create a ModeledEntity from a custom target

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Base-Entity

Instantiate the custom base entity and register it with the ModelEngineAPI.

```java
CustomBaseEntity baseEntity = new CustomBaseEntity(customTarget);
ModeledEntity modeledEntity = ModelEngineAPI.createModeledEntity(baseEntity);
// The rest is exactly the same
```

--------------------------------

### MythicMobs Pack Directory Structure

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/MythicMobs

Place .bbmodel files within the models directory of a MythicMobs pack to enable automatic parsing by Model Engine.

```text
MythicMobs
  |-- packs
      |-- YourPackName
          |-- models
              |-- YourModel.bbmodel
              |-- otherDirectory
                  |-- AnotherModel.bbmodel
```

--------------------------------

### Play an animation

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Play-Stop-Animation

Triggers an animation on the model with specified transition and loop settings.

```java
// Get a hold of the ActiveModel you want to modify
ActiveModel model = ...
// Get the model's AnimationHandler
AnimationHandler handler = model.getAnimationHandler();
// Play an animation 
handler.playAnimation("attack", 0.3, 0.3, 1, true);
```

--------------------------------

### Registering a Behavior Parser

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Bone-Behaviors

Implement a Bukkit listener to register custom behavior parsers when the RegisterBehaviorParserEvent is fired.

```java
public class BehaviorParserListener implements Listener {

    @EventHandler
    public void onRegister(RegisterBehaviorParserEvent event) {
        event.register(new GlowBehaviorParser());
    }

}
```

--------------------------------

### Implement a Custom Script Reader

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Script-Reader

Create a class implementing the ScriptReader interface to define custom logic for scriptable keyframes.

```java
public class CustomScriptReader implements ScriptReader {

	@Override
	public void read(IAnimationProperty property, String script) {
		// property -> the animation currently playing this keyframe
		// script   -> everything after your reader prefix (the "reader:" part is stripped)

		ActiveModel model = property.getModel();
		Object original = model.getModeledEntity().getBase().getOriginal();

		// Interpret `script` and do your custom logic here.
		// e.g. only act when the base is a Bukkit entity:
		if (original instanceof Entity entity) {
			// ...
		}
	}

}
```

--------------------------------

### Ignite Mounted Model Condition

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Conditions/RidingModel

Checks if the target is riding a model and ignites the model if true using a sudo skill.

```yaml
ExampleSkill:
  TargetConditions:
  - ridingmodel true
  Skills:
  - sudoskill{s=[
      - ignite @mountedmodel
    ]}
```

--------------------------------

### Implement a Custom Animation Handler

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Animation-Handler

A template for creating a custom animation handler by implementing the AnimationHandler interface.

```java
public class CustomAnimationHandler implements AnimationHandler {

    private final ActiveModel activeModel;

    public CustomAnimationHandler(ActiveModel activeModel) {
        this.activeModel = activeModel;
    }

    @Override
    public ActiveModel getActiveModel() {
        return activeModel;
    }

    @Override
    public String getId() {
        // Used as the registry key when the model is saved/loaded
        return "custom";
    }

    @Override
    public void prepare() {
        // Called every tick before bones update; advance your animation state here
    }

    @Override
    public void updateBone(ModelBone bone) {
        // Apply the current animation transform onto the given bone
    }

    @Override
    public void tickGlobal() {
        // Called every tick for global keyframes (sounds, particles, etc.)
    }

    @Override
    public boolean hasFinishedAllAnimations() {
        // Return true when nothing is playing
    }

    @Override
    public @Nullable IAnimationProperty playAnimation(String animation, double lerpIn, double lerpOut, double speed, boolean force) {
        // Start an animation; return its IAnimationProperty, or null if it could not play
    }

    @Override
    public boolean playAnimation(IAnimationProperty property, boolean force) {
        // Start an already-built property
    }

    @Override
    public boolean isPlayingAnimation(String animation) { ... }

    @Override
    public void stopAnimation(String animation) {
        // Stop gracefully (play the lerp-out)
    }

    @Override
    public void forceStopAnimation(String animation) {
        // Stop immediately, skipping lerp-out
    }

    @Override
    public void forceStopAllAnimations() { ... }

    @Override
    public @Nullable IAnimationProperty getAnimation(String animation) { ... }

    @Override
    public Map<String, IAnimationProperty> getAnimations() {
        // Unordered, immutable map of all live properties
    }

    @Override
    public void setDefaultProperty(DefaultProperty defaultProperty) { ... }

    @Override
    public DefaultProperty getDefaultProperty(ModelState state) { ... }

}
```

--------------------------------

### Check target driving status and ignite model

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Conditions/DrivingModel

Verifies if the target is driving a model and applies an ignite effect to the mounted model via a sudo skill.

```yaml
ExampleSkill:
  TargetConditions:
  - drivingmodel true
  Skills:
  - sudoskill{s=[
      - ignite @mountedmodel
    ]}
```

--------------------------------

### Spawn a model with a springy tail segment

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/Segment

Applies a segment to a spawned model to create a wiggling tail effect.

```yaml
  Skills:
    - model{m=rat} @self ~onSpawn
    - segment{m=rat;p=tail;extend=0.25} @self ~onSpawn
```

--------------------------------

### Overlap animations using the Hybrid system

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/State

Plays multiple animations simultaneously by explicitly setting priority using the priority attribute.

```yaml
Skills:
  # Play the hold_axe animation, which we assign a lower priority
  - state{mid=kindletronjr;s=hold_axe;li=3;lo=3;priority=1} @self
  # Play the charge animation, which we assign a higher priority
  - state{mid=kindletronjr;s=charge;li=3;lo=3;priority=2} @self
```

--------------------------------

### Register Animation Timelines

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Associate bone timelines with a BlueprintAnimation and configure animation properties.

```java
BlueprintAnimation animation = new BlueprintAnimation(modelBlueprint, "my_animation");

Timeline timeline = new Timeline(animation, false);
// ... fill timeline via getKeyframe(...) as shown above ...

animation.getTimelines().put(boneUuid, timeline); // boneUuid is the BlueprintBone UUID
animation.setLength(2.0);                           // length in seconds
animation.setLoopMode(BlueprintAnimation.LoopMode.LOOP);
animation.setOverride(false);
```

--------------------------------

### Add Script Keyframes

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Register script execution commands to the animation's global timeline.

```java
ScriptKeyframe script = blueprintAnimation.getGlobalTimeline().getKeyframe(time, KeyframeTypes.SCRIPT);
script.getScript().add(ScriptKeyframe.Script.from("playsound:entity.zombie.ambient"));
```

--------------------------------

### Resolving Mechanic Conflicts with Namespaces

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/MythicMobs

Use the meg: prefix to differentiate Model Engine mechanics from other addon mechanics when naming conflicts occur.

```yaml
  Skills:
    # The Crucible mechanic
    - setitemmodel{m=3} @self

    # The Model Engine mechanic
    - meg:setitemmodel{mid=testmodel;bone=examplebone;i=STONE} @self
```

--------------------------------

### Call MythicMobs Skills in Keyframes

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Modeling/Scriptable-Keyframes

Use the mm: prefix to trigger custom MythicMobs skills within an animation keyframe.

```yml
Primary_5:
  Skills:
    - message{m="Get punched";audience=world} @self
    - explode @ModelPart{m=dr_axis;p=attack_point}
```

```yml
Primary_5:
  Skills:
    - message{m=<skill.dialogue>;audience=world} @self
    - explode @ModelPart{m=dr_axis;p=attack_point}
```

--------------------------------

### Populate Vector Keyframes

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Set keyframe data and interpolation modes for vector-based keyframes.

```java
VectorKeyframe frame = timeline.getKeyframe(time, KeyframeTypes.POSITION);
frame.setXFactor(0.0625f)
     .setYFactor(0.0625f)
     .setZFactor(-0.0625f)
     .setX(new DoubleData(x))
     .setY(new DoubleData(y))
     .setZ(new DoubleData(z));
frame.setInterpolation("linear"); // "linear", "step", "catmullrom", "bezier"
```

--------------------------------

### Set skin using username

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/ModelPlayerSkin

Applies a skin based on a specific player's username.

```yaml
Skills:
  - model{m=skin} @self ~onSpawn
  - modelplayerskin{username=Ticxo} @self ~onSpawn
```

--------------------------------

### Apply brightness to a model part

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/Brightness

Sets the block and sky light levels to 15 for the 'eyes' part of a custom spider model upon spawning.

```yaml
  Skills:
  - model{m=customSpider} @self ~onSpawn
  - brightness{p=eyes;b=15;s=15} @self ~onSpawn
```

--------------------------------

### Play an animation

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/State

Plays an animation on a mob when it attacks, with specified transition times.

```yaml
Skills:
  # Play an attack animation that will only play once
  - state{mid=kindletronjr;s=attack;li=3;lo=3} @self ~onAttack
```

--------------------------------

### Access Timeline Interpolators and Keyframes

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Retrieve or create interpolators and keyframes for specific keyframe types.

```java
// Whether an interpolator for this type already exists
boolean has = timeline.hasInterpolator(KeyframeTypes.POSITION);

// Get (lazily create) the interpolator for a keyframe type
KeyframeInterpolator<VectorKeyframe, Vector3f> interp = timeline.getInterpolator(KeyframeTypes.POSITION);

// Get (lazily create) the keyframe at a given time, in seconds
VectorKeyframe frame = timeline.getKeyframe(0.0f, KeyframeTypes.POSITION);
```

--------------------------------

### Use specific animation handler method

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Play-Stop-Animation

Demonstrates conditional logic to use IStateMachineHandler methods if available, falling back to the default handler otherwise.

```java
ActiveModel model = ...
AnimationHandler handler = model.getAnimationHandler();
if(handler instanceof IStateMachineHandler stateMachineHandler) {
	// Using special stop animation method from IStateMachineHandler
	stateMachineHandler.stopAnimation(1, "eating");
}else {
	// Fallback animation stopping with default method
	handler.stopAnimation("eating");
}
```

--------------------------------

### Launch projectile from a model part

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Targeters/ModelPart

Sets the origin of a projectile to a specific offset location on a model bone.

```yaml
ExampleSkill:
  Skills:
  - projectile{
    ...;
    origin=@modelpart{mid=your_model;pid=boneid;location=0,1,0};
    fromorigin=true
    } @target
```

--------------------------------

### Configure Model Engine Dependency

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API

Add the Lumine repository and Model Engine dependency to your project build configuration.

```xml
<repository>
  <id>nexus</id>
  <name>Lumine Public</name>
  <url>https://mvn.lumine.io/repository/maven-public/</url>
</repository>

<dependency>
  <groupId>com.ticxo.modelengine</groupId>
  <artifactId>ModelEngine</artifactId>
  <version>version</version>
  <scope>provided</scope>
</dependency>
```

```kotlin
repositories {
    maven(url = "https://mvn.lumine.io/repository/maven-public/")
}

dependencies {
    compileOnly("com.ticxo.modelengine:ModelEngine:version")
}
```

```groovy
repositories {
    maven { url 'https://mvn.lumine.io/repository/maven-public/' }
}

dependencies {
    compileOnly 'com.ticxo.modelengine:ModelEngine:version'
}
```

--------------------------------

### Set skin using UUID

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/ModelPlayerSkin

Applies a skin based on a player's UUID, supporting both standard and dashed formats.

```yaml
Skills:
  - model{m=skin} @self ~onSpawn
  - modelplayerskin{uuid=853c80ef3c3749fdaa49938b674adae6} @self ~onSpawn
  # The following format works too
  - modelplayerskin{uuid=853c80ef-3c37-49fd-aa49-938b674adae6} @self ~onSpawn
```

--------------------------------

### Mount an Entity with a Custom Controller

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Mount-Controller

Use the MountControllerType defined in your controller class to mount a driver to an ActiveModel.

```java
ActiveModel model=...
model.getMountManager().ifPresent(mountManager -> {
	mountManager.mountDriver(entity, CustomMountController.CUSTOM);
});
```

--------------------------------

### Play Animations on a Model

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Timeline

Trigger an animation playback using the model's AnimationHandler.

```java
ActiveModel model = ...;
model.getAnimationHandler().playAnimation(
        "my_animation", // animation ID (BlueprintAnimation name)
        0.1,            // lerp in, seconds
        0.1,            // lerp out, seconds
        1.0,            // speed multiplier
        true            // force restart if already playing
);
```

--------------------------------

### ModelEngineAPI.createActiveModel

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Animation-Handler

Creates an ActiveModel with a custom animation handler supplier.

```APIDOC
## ModelEngineAPI.createActiveModel

### Description
Creates a new ActiveModel instance, optionally binding a custom animation handler via a supplier function.

### Signature
`ActiveModel createActiveModel(String id, RendererSupplier renderer, Function<ActiveModel, AnimationHandler> handlerSupplier)`

### Parameters
- **id** (String) - The model identifier.
- **renderer** (RendererSupplier) - The renderer supplier (pass null for default).
- **handlerSupplier** (Function<ActiveModel, AnimationHandler>) - A supplier function to create the custom animation handler.
```

--------------------------------

### AnimationHandler.playAnimation

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Play-Stop-Animation

Plays a specific animation on the model with defined transition and loop settings.

```APIDOC
## playAnimation(String animation, double lerpIn, double lerpOut, double speed, boolean loop)

### Description
Plays an animation on the model with specified transition times, playback speed, and looping behavior.

### Parameters
- **animation** (String) - The name of the animation to play.
- **lerpIn** (double) - The transition time to enter the animation.
- **lerpOut** (double) - The transition time to exit the animation.
- **speed** (double) - The playback speed multiplier.
- **loop** (boolean) - Whether the animation should loop.
```

--------------------------------

### Animation Metadata Configuration

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Assets/Demo/player_model.bbmodel

Defines animation timing and interpolation settings for specific model components identified by UUIDs.

```json
{
		"00bc05bf-f450-e30a-7412-da6e2ad16a42": {
			"animation": {
				"frametime": 2
			}
		},
		"443c5751-cba3-f9d3-0a87-294387672844": {
			"animation": {
				"frametime": 2
			}
		},
		"e6522cda-0942-069d-596d-a91b84d9b71d": {
			"animation": {
				"frametime": 2
			}
		},
		"99ebebd1-78db-784d-6807-590a27e33623": {
			"animation": {
				"frametime": 1
			}
		},
		"65e5a6d2-dda4-bf73-fc74-79e2a4bae8f9": {
			"animation": {
				"frametime": 1
			}
		},
		"8c8641e2-824d-b29e-747e-21d7c785e4db": {
			"animation": {
				"frametime": 1
			}
		},
		"54581759-42d9-1105-9f25-05c444ae2c73": {
			"animation": {
				"frametime": 1
			}
		},
		"7ce9049f-7d09-86be-cc46-ca646829e52c": {
			"animation": {
				"frametime": 1
			}
		},
		"f96d4743-953f-d8c3-b6c3-0e3558971cd9": {
			"animation": {
				"frametime": 1
			}
		},
		"5fb778df-830e-e4e4-9eb8-37c9ff8674c5": {
			"animation": {
				"frametime": 4
			}
		},
		"88e29ae1-b677-75d4-6ecf-7cece834cdec": {
			"animation": {
				"frametime": 4
			}
		},
		"9118bc58-e4ff-78f5-4650-ea717add5cf6": {
			"animation": {
				"interpolate": true,
				"frametime": 1
			}
		},
		"6a0d8d6f-6788-a2c0-165d-0ae401096d71": {
			"animation": {
				"interpolate": true,
				"frames": [
					{
						"index": 0,
						"time": 40
					},
					0,
					{
						"index": 1,
						"time": 4
					},
					{
						"index": 2,
						"time": 3
					},
					{
						"index": 3,
						"time": 2
					},
					{
						"index": 4,
						"time": 1
					},
					{
						"index": 5,
						"time": 1
					},
					{
						"index": 6,
						"time": 2
					},
					{
						"index": 7,
						"time": 3
					},
					{
						"index": 8,
						"time": 4
					}
				]
			}
		},
		"f67e74be-cb7d-3619-8e9e-b60c3bdb4964": {
			"animation": {
				"interpolate": true,
				"frametime": 10
			}
		}
```

--------------------------------

### Apply VFX to a Projectile

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/VFX

Spawns a projectile with a specific VFX model attached to a bone.

```yaml
  Skills:
  - projectile{v=20;i=1;hR=0.25;vR=0.25;hnp=true;
    oS=[
      - vfx{mid=weapon_vfx;pid=fire_bolt}
    ];
    oT=[
      - effect:particles{particle=flame;amount=1;hS=0;vS=0;speed=0} @origin
    ];
    oH=[
      - damage{a=1}
    ]}
```

--------------------------------

### Bind Custom Animation Handler to ActiveModel

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Animation-Handler

Pass a supplier to createActiveModel to bind a custom handler at creation time. Passing null defaults to the built-in handler.

```java
ActiveModel model = ModelEngineAPI.createActiveModel(
        "my_model",
        null,                       // renderer supplier (null = default)
        CustomAnimationHandler::new // handler supplier
);
```

--------------------------------

### Implement a custom bone behavior class

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Bone-Behaviors

Extend AbstractBoneBehavior to access bone data and override specific pipeline callbacks for custom rendering or transformation logic.

```java
public class GlowBehavior extends AbstractBoneBehavior<GlowBehavior> {

    private final boolean enabled;

    public GlowBehavior(ModelBone bone, BoneBehaviorType<GlowBehavior> type, BoneBehaviorData data) {
        super(bone, type, data);
        // Read the parsed config off the data map. The typed overload returns the default if absent/mistyped.
        this.enabled = data.get("enabled", false);
    }

    @Override
    public void onModelInitialized() {
        // Called once the model is fully built
    }

    @Override
    public void postTransformDecompose() {
        // Mutate the bone's transform after it has been decomposed, e.g.
        // bone.getGlobalTransform()...
    }

    @Override
    public boolean isHidden() {
        return !enabled; // Hide this bone's render output
    }

}
```

--------------------------------

### vfxbrightness

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/VFXBrightness

Sets the block and sky light levels of a VFX.

```APIDOC
## vfxbrightness

### Description
Sets the block and sky light levels of the VFX.

### Attributes
- **block** (Integer) - Optional - The VFX block light level. Default: -1. Alias: b.
- **sky** (Integer) - Optional - The VFX sky light level. Default: -1. Alias: s.

### Example
```yaml
Skills:
  - skill{s=[
    - vfx{mid=weapon_vfx;pid=fire_bolt}
    - vfxbrightness{block=15;sky=0}
    ]} @self ~onSpawn
```
```

--------------------------------

### Add a model to an entity

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/Model

Applies a model to an entity upon spawning or loading, utilizing the state machine system.

```yaml
Skills:
  - model{m=kindletronsr;usm=true} @self ~onSpawn
  # Run the same mechanic on load if the mob is persistent 
  - model{m=kindletronsr;usm=true} @self ~onLoad
```

--------------------------------

### Sync animations with attacks

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/State

Syncs an attack animation by canceling the event, playing the animation, and manually damaging the target after a delay.

```yaml
Skills:
  - skill{s=[
    - cancelevent
    - skill{s=[
    - state{s=attack} @self
    - delay 5
    - damage{a=2;type=ATTACK} @EIC{r=3;a=180;conditions=[ - isPlayer{} true ]}
    ];cooldown=1}
    ];sync=true} ~onAttack
```

--------------------------------

### Removing a Dummy

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Basic/Per-Player-Model

Marks a dummy for removal and triggers automatic despawning.

```APIDOC
## Removing a Dummy

### Description
Marks the dummy as removed, causing Model Engine to automatically despawn the associated model.

### Usage
```java
dummy.setRemoved(true);
```
```

--------------------------------

### Register a Custom Script Reader

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/API/Advanced/Custom-Script-Reader

Register the custom reader implementation with the ScriptReaderRegistry during plugin startup.

```java
// On plugin start-up
ModelEngineAPI.getAPI().getScriptReaderRegistry().register("custom", new CustomScriptReader());
```

--------------------------------

### Tint the entire model blue

Source: https://git.mythiccraft.io/mythiccraft/model-engine-4/-/wikis/Skills/Mechanics/Tint

Applies a blue tint to the entire MiniSoldier model by omitting the part attribute.

```yaml
  Skills:
  - model{m=MiniSoldier} @self ~onSpawn
  - tint{m=MiniSoldier;c=3986FE} @self ~onSpawn
```
Tokens:
Raw