Model Region - WeakAuras

The Model region displays 3D models from the game, including creatures, objects, and player characters. Models can be static or animated.

Region Type

regionType = "model"

Default Configuration

local default = {
  model_path = "Creature/Arthaslichking/arthaslichking.m2",
  modelIsUnit = false,
  model_x = 0,
  model_y = 0,
  model_z = 0,
  width = 200,
  height = 200,
  sequence = 1,
  advance = false,
  rotation = 0,
  scale = 1,
  selfPoint = "CENTER",
  anchorPoint = "CENTER",
  anchorFrameType = "SCREEN",
  xOffset = 0,
  yOffset = 0,
  frameStrata = 1,
  border = false,
  borderColor = {1.0, 1.0, 1.0, 0.5},
  backdropColor = {1.0, 1.0, 1.0, 0.5},
  borderEdge = "None",
  borderOffset = 5,
  borderInset = 11,
  borderSize = 16,
  borderBackdrop = "Blizzard Tooltip"
}

Model Sources

File Path Models

Direct path to M2 model files:

data.modelIsUnit = false
data.model_path = "Creature/Arthaslichking/arthaslichking.m2"

Unit Models

Display a unit’s current model:

data.modelIsUnit = true
data.model_path = "player"  -- or "target", "focus", "party1", etc.

Display Info Models

Use a display info ID:

data.modelDisplayInfo = 12345

Functions

SetAlpha

Sets the transparency of the model.

region:SetAlpha(alpha)

alpha

number

Alpha transparency (0-1)

Example:

-- Set model to 50% transparent
region:SetAlpha(0.5)

SetRegionWidth

Sets the width of the model region.

region:SetRegionWidth(width)

width

number

Width in pixels

SetRegionHeight

Sets the height of the model region.

region:SetRegionHeight(height)

height

number

Height in pixels

Scale

Scales the region by the given factors.

region:Scale(scalex, scaley)

scalex

number

Horizontal scale factor (negative mirrors horizontally)

scaley

number

Vertical scale factor (negative mirrors vertically)

Example:

-- Double the size
region:Scale(2, 2)

-- Mirror horizontally
region:Scale(-1, 1)

SetRotation

Sets the base rotation of the model.

region:SetRotation(degrees)

degrees

number

Rotation in degrees

Example:

-- Rotate 90 degrees
region:SetRotation(90)

SetAnimRotation

Sets the animated rotation that overrides base rotation.

region:SetAnimRotation(degrees)

degrees

number

Rotation in degrees

UpdateEffectiveRotation

Recalculates and applies the effective rotation (base + animation).

region:UpdateEffectiveRotation()

GetBaseRotation

Returns the base rotation value (excluding animation).

local rotation = region:GetBaseRotation()

rotation

number

Base rotation in degrees

PreShow

Called before showing the region to initialize the model.

region:PreShow()

PreHide

Called before hiding the region to release the model.

region:PreHide()

Update

Refreshes the model region display based on current state.

region:Update()

Model Frame Functions

The underlying model frame (region.model) supports PlayerModel API:

SetPosition

Positions the model camera:

region.model:SetPosition(z, x, y)

number

Distance from camera (closer = larger)

number

Horizontal position offset

number

Vertical position offset

Example:

-- Zoom in and center
region.model:SetPosition(0, 0, 0)

-- Zoom out and shift right
region.model:SetPosition(1, -0.5, 0)

SetFacing

Sets the model’s facing direction:

region.model:SetFacing(radians)

radians

number

Facing angle in radians

SetSequence

Sets which animation sequence to play:

region.model:SetSequence(sequence)

sequence

number

Animation sequence ID

SetSequenceTime

Sets the time position in the current animation:

region.model:SetSequenceTime(sequence, time)

sequence

number

Animation sequence ID

time

number

Time in milliseconds

Animation

To enable animated models:

data.advance = true
data.sequence = 1 -- Animation sequence ID

This creates an OnUpdate script that advances the animation automatically. Example - Custom Animation Speed:

function()
  local region = aura_env.region
  if region.model then
    local elapsed = (GetTime() - (aura_env.startTime or GetTime())) * 1000
    region.model:SetSequenceTime(data.sequence, elapsed * 2) -- 2x speed
  end
end

Unit Model Events

When modelIsUnit is true, the model automatically updates when the unit’s appearance changes:

UNIT_MODEL_CHANGED - Unit’s model changed
PLAYER_TARGET_CHANGED - Target unit changed (when model_path is “target”)
PLAYER_FOCUS_CHANGED - Focus unit changed (when model_path is “focus”)

Model Pooling

Model regions use object pooling for performance:

Models are acquired from a pool when shown
Models are released back to the pool when hidden
Separate pools for unit models and file path models

Border Configuration

Optional border frame around the model:

data.border = true
data.borderEdge = "Blizzard Tooltip" -- Border texture
data.borderSize = 16                 -- Border thickness
data.borderOffset = 5                -- Distance from model
data.borderInset = 11                -- Backdrop inset
data.borderColor = {1, 1, 1, 0.5}   -- Border RGBA
data.backdropColor = {0, 0, 0, 0.8} -- Background RGBA

Properties

Property	Type	Setter	Description
width	number	SetRegionWidth	Model region width
height	number	SetRegionHeight	Model region height

Code Examples

Display Player Model

data.modelIsUnit = true
data.model_path = "player"
data.model_x = 0
data.model_y = 0
data.model_z = 0

Display Target with Animation

data.modelIsUnit = true
data.model_path = "target"
data.advance = true
data.sequence = 4 -- Often the "ready" animation

Specific Creature Model

data.modelIsUnit = false
data.model_path = "Creature/Deathwing/deathwing.m2"
data.model_z = 1.5  -- Zoom out to see whole model
data.rotation = 45  -- Rotate to show profile

Rotating Model Animation

-- In TSU or custom trigger
function()
  local region = aura_env.region
  local time = GetTime()
  local rotation = (time * 45) % 360 -- 45 degrees per second
  region:SetAnimRotation(rotation)
end

Dynamic Model Based on Class

function()
  local region = aura_env.region
  local _, class = UnitClass("player")
  
  local models = {
    WARRIOR = "Creature/Warrior/warrior.m2",
    MAGE = "Creature/Mage/mage.m2",
    -- etc...
  }
  
  if models[class] then
    data.model_path = models[class]
    region:PreShow() -- Reload model
  end
end

Model Position Adjustment

function()
  local region = aura_env.region
  if region.model then
    -- Adjust based on some state
    local zoom = aura_env.state.value or 1
    region.model:SetPosition(zoom, 0, 0)
  end
end

Boss Model Display

-- Show current boss model
data.modelIsUnit = true
data.model_path = "boss1"
data.width = 300
data.height = 300
data.model_z = 2.0  -- Zoom out for large models
data.border = true
data.borderColor = {1, 0, 0, 1}  -- Red border

Model Fade In/Out

-- Custom animation
function()
  local region = aura_env.region
  local elapsed = GetTime() - (aura_env.showTime or GetTime())
  local alpha = math.min(1, elapsed / 2) -- Fade in over 2 seconds
  region:SetAlpha(alpha)
end

Performance Notes

Models are more expensive than textures - use sparingly
Unit models update automatically but can cause performance impact
Model pooling helps with show/hide performance
Animated models (advance = true) require OnUpdate handlers
Models are hidden during cinematics and world map to prevent Blizzard UI issues

Common Model Paths

Some useful model paths:

-- Player races
"Character/Human/Male/HumanMale.m2"
"Character/Orc/Male/OrcMale.m2"

-- Creatures
"Creature/Deathwing/deathwing.m2"
"Creature/Arthaslichking/arthaslichking.m2"
"Creature/Ragnaros/ragnaros.m2"

-- Objects
"Spells/Arcane_missile.m2"
"World/Expansion02/Doodads/generic/bloodelf/tables/be_table01.m2"

Core API

Systems

Region Types

​Region Type

​Default Configuration

​Model Sources

​File Path Models

​Unit Models

​Display Info Models

​Functions

​SetAlpha

​SetRegionWidth

​SetRegionHeight

​Scale

​SetRotation

​SetAnimRotation

​UpdateEffectiveRotation

​GetBaseRotation

​PreShow

​PreHide

​Update

​Model Frame Functions

​SetPosition

​SetFacing

​SetSequence

​SetSequenceTime

​Animation

​Unit Model Events

​Model Pooling

​Border Configuration

​Properties

​Code Examples

​Display Player Model

​Display Target with Animation

​Specific Creature Model

​Rotating Model Animation

​Dynamic Model Based on Class

​Model Position Adjustment

​Boss Model Display

​Model Fade In/Out

​Performance Notes

​Common Model Paths

Build docs developers (and LLMs) love

Region Type

Default Configuration

Model Sources

File Path Models

Unit Models

Display Info Models

Functions

SetAlpha

SetRegionWidth

SetRegionHeight

Scale

SetRotation

SetAnimRotation

UpdateEffectiveRotation

GetBaseRotation

PreShow

PreHide

Update

Model Frame Functions

SetPosition

SetFacing

SetSequence

SetSequenceTime

Animation

Unit Model Events

Model Pooling

Border Configuration

Properties

Code Examples

Display Player Model

Display Target with Animation

Specific Creature Model

Rotating Model Animation

Dynamic Model Based on Class

Model Position Adjustment

Boss Model Display

Model Fade In/Out

Performance Notes

Common Model Paths