Animation Coord Provider

Animation Coord Provider defines how an Action Animation calculates, transforms, or retrieves its movement coordinates.

These providers control how an animation moves the entity through the world, how destination locations are resolved, and how movement should be interpreted during playback.

⚠️ This property is only available for Action Animations and their heirs (Attack Animation, AirSlash, e.g), static animations, movement or guard for example (static group) cannot use this property.

This property can be applied through any animation operation that supports Action Properties, including Registry, Virtualization, and Configuration.

---

📋 Property Name

"animation_coords": {
    ...
}

---

📚 Core Parameters

Field	Type	Description
coord_type	String	Specifies which animation coordinate property will be modified.
coord_function	String	Function used to resolve or transform the coordinates.

---

⚙️ Coordinate Types

The selected coord_type determines where the coordinate function is applied.

Type	Description
coord_set_begin	Applies a coordinate transformation when the animation begins.
coord_set_tick	Updates the coordinates continuously during playback.
coord_get	Defines how movement coordinates are calculated from the animation.
dest_location_provider	Supplies the destination position used by movement-based animations.
entity_yrot_provider	Controls the entity rotation during playback.
dest_coord_yrot_provider	Controls the destination rotation used during coordinate tracing.

---

🎯 Coordinate Functions

Different coordinate types support different functions depending on what they modify.

Coordinate Getters

Used by coord_get.

Function	Description
model_coord	Uses animation movement in model space.
world_coord	Uses world-space coordinates.
attached	Uses the grapple target when available; otherwise falls back to model_coord.

Destination Providers

Used by dest_location_provider.

Function	Description
no_dest	No destination is provided.
attack_target_location	Uses the current attack target position.
synched_dest_variable	Reads a synchronized destination variable.
synched_target_entity_location_variable	Uses the synchronized target entity location.

Rotation Providers

Used by entity_yrot_provider and dest_coord_yrot_provider.

Function	Description
look_dest	Rotates the entity toward the destination.
mob_attack_target_look	Makes mobs face their attack target while the animation plays.

Coordinate Setters

Used by coord_set_begin and coord_set_tick.

Function	Description
raw_coord	Uses the original animation coordinates without modification.
raw_coord_with_x_rot	Uses the original coordinates while applying entity pitch.
trace_origin_as_destination	Transforms the animation so its origin reaches the destination.
trace_target_distance	Scales movement according to the target distance.
trace_target_location_rotation	Scales movement while aligning rotation toward the destination.
vex_trace	Generates flying movement similar to a Vex attack.

---

💡 Understanding the System

• Animation Coord Provider is composed of two independent parts.
• The Coordinate Type determines which animation property will receive the function.
• The Coordinate Function determines how that property behaves.

For example:

{
  "coord_type": "dest_location_provider",
  "coord_function": "attack_target_location"
}

means: modify the destination provider; use the current attack target as the destination.