Files
ClassicAPI/src/embed/AddOns/!!!ClassicAPI/FrameXML/ModelScene/ModelSceneControlFrame.lua
T
Brues 1e1989d230 feat(model): seat the player on a mount in the dressing room
A ModelScene mount actor now seats a rider the way 1.12's world mount
(0x00607A00) does: CM2Model::Attach (0x00712F70) puts the rider's model on
the mount's attachment 0, and the rider plays the seat animation (91).
Attach takes the rider off the scene's animate list and the mount holds a
reference on it, so the actor update no longer re-links a seated rider, a
rider that drops its model detaches first, and a mount that drops its
model unseats the rider through the CM2Model destructor (HandleClose2
0x007103A0 destroys at zero). The seated rider keeps its placement, now
relative to the seat, as the world mount sets the attached rider's base
transform.

CalculateMountScale is the mount display's CreatureModelScale
(CreatureDisplayInfo col 4, OFF_CREATUREDISPLAYINFO_SCALE): the world
seats the rider at +0x98 over that scale, and +0x98 is always 1.0.
DetachFromMount only detaches, leaving the seat animation, unlike the
world's Dismount (0x00607CE0). M2::Attach / M2::Detach wrap the two calls
for the actor and the visual kits; Detach tests the parent first, since
the engine call drops a reference unconditionally.

C_MountJournal.GetMountFromItem returns the mount of an item whose use
spell applies SPELL_AURA_MOUNTED; an uncached item starts its load.
Enum.ModelBlendOperation is registered.

The dressing room gains retail's mount mode: DressUpLink,
DressUpMountLink and DressUpMount show a ModelScene over DressUpFrame's
backdrop, above the button row, in place of DressUpModel (whose scale 2
rect reaches over the buttons). DressUpItem returns to the player model.
A mount whose creature is not cached opens when CREATURE_DATA_LOAD_RESULT
arrives. Control-click previews a mount from a spell link (Turtle-shaped
links too), from a cached item that is not wearable, and from the
spellbook, where a mount spell then never casts.

Retail's ModelSceneControlFrame is ported with its strings in every
locale and GameTooltip_AddBodyLine. Its seven atlases are built in: the
sprites cut from retail's CommonIcons / CommonButtons into one 128x128
palettized BLP2 near their drawn size, since a built-in texture has one
mip. Held rotation counts retail's per-frame 0.05 per 1/60 s, the speed
of 1.12's own rotate buttons, instead of per frame at 1.12's uncapped
frame rates.
2026-11-09 11:51:26 -06:00

283 lines
8.0 KiB
Lua

-- Verbatim backport of retail's Blizzard_SharedXML/ModelSceneControlFrame.lua.
local DEFAULT_ZOOM_INCREMENT = 1;
local DEFAULT_ROTATE_INCREMENT = 0.05;
--------------------------------------------------
-- MODEL SCENE CONTROL FRAME MIXIN
ModelSceneControlFrameMixin = {};
function ModelSceneControlFrameMixin:OnLoad()
if self.enableZoom then
local increment = self:GetZoomIncrement();
self.zoomInButton:SetZoomAmount(increment);
self.zoomInButton:Init();
self.zoomOutButton:SetZoomAmount(-increment);
self.zoomOutButton:Init();
end
self.zoomInButton:SetShown(self.enableZoom);
self.zoomOutButton:SetShown(self.enableZoom);
if self.enableRotate then
local increment = self:GetRotateIncrement();
self.rotateLeftButton:SetRotation("left");
self.rotateLeftButton:SetRotationIncrement(increment);
self.rotateLeftButton:Init();
self.rotateRightButton:SetRotation("right");
self.rotateRightButton:SetRotationIncrement(increment);
self.rotateRightButton:Init();
end
self.rotateLeftButton:SetShown(self.enableRotate);
self.rotateRightButton:SetShown(self.enableRotate);
if self.enableReset then
self.resetButton:Init();
end
self.resetButton:SetShown(self.enableReset);
end
function ModelSceneControlFrameMixin:OnShow()
self:UpdateLayout();
end
function ModelSceneControlFrameMixin:OnEnter()
self:SetAlpha(1);
end
function ModelSceneControlFrameMixin:OnLeave()
self:SetAlpha(0.5);
end
function ModelSceneControlFrameMixin:SetZoomIncrement(increment)
self.zoomIncrement = increment or DEFAULT_ZOOM_INCREMENT;
end
function ModelSceneControlFrameMixin:GetZoomIncrement()
return self.zoomIncrement or DEFAULT_ZOOM_INCREMENT;
end
function ModelSceneControlFrameMixin:SetRotateIncrement(increment)
self.rotationIncrement = increment or DEFAULT_ROTATE_INCREMENT;
end
function ModelSceneControlFrameMixin:GetRotateIncrement()
return self.rotationIncrement or DEFAULT_ROTATE_INCREMENT;
end
function ModelSceneControlFrameMixin:SetModelScene(modelScene)
self.modelScene = modelScene;
self.zoomInButton:SetModelScene(modelScene);
self.zoomOutButton:SetModelScene(modelScene);
self.rotateLeftButton:SetModelScene(modelScene);
self.rotateRightButton:SetModelScene(modelScene);
self.resetButton:SetModelScene(modelScene);
end
function ModelSceneControlFrameMixin:UpdateLayout()
local lastButton;
local hPadding = self.buttonHorizontalPadding or 0;
local vPadding = 0;
local buttonSize = 32;
local totalHeight = buttonSize;
local totalWidth = 2; -- Initial non-zero total width to prevent flickering from negataive padding
local function LayoutButton(button)
button:ClearAllPoints();
if lastButton then
button:SetPoint("LEFT", lastButton, "RIGHT", hPadding, vPadding);
else
button:SetPoint("LEFT", 0, vPadding);
end
totalWidth = totalWidth + buttonSize + hPadding;
lastButton = button;
end
if self.enableZoom then
-- Make sure that zoom is supported on the model scene.
if self.modelScene then
local camera = self.modelScene:GetActiveCamera();
self.canZoom = camera ~= nil and camera:GetZoomAvailable();
self.zoomInButton:SetShown(self.canZoom);
self.zoomOutButton:SetShown(self.canZoom);
end
if self.canZoom then
LayoutButton(self.zoomInButton);
LayoutButton(self.zoomOutButton);
end
end
if self.enableRotate then
LayoutButton(self.rotateLeftButton);
LayoutButton(self.rotateRightButton);
end
if self.enableReset then
LayoutButton(self.resetButton);
end
self:SetSize(totalWidth, totalHeight);
end
--------------------------------------------------
-- MODEL SCENE CONTROL BUTTON MIXIN
ModelSceneControlButtonMixin = {};
function ModelSceneControlButtonMixin:Init(clickTypes, atlas, tooltip, tooltipText)
self:RegisterForClicks(clickTypes);
if atlas then
self.Icon:SetAtlas(atlas);
end
self.tooltip = tooltip;
self.tooltipText = tooltipText;
end
function ModelSceneControlButtonMixin:SetModelScene(modelScene)
self.modelScene = modelScene;
end
function ModelSceneControlButtonMixin:OnMouseDown()
self.Icon:AdjustPointsOffset(1, -1);
self:GetParent().buttonDown = self;
end
function ModelSceneControlButtonMixin:OnMouseUp()
self.Icon:AdjustPointsOffset(-1, 1);
self:GetParent().buttonDown = nil;
end
function ModelSceneControlButtonMixin:OnClick()
--override for your mouse click
end
function ModelSceneControlButtonMixin:OnEnter()
self:GetParent():SetAlpha(1);
if ( GetCVar("UberTooltips") == "1" ) then
local tooltip = GetAppropriateTooltip();
local topLevelParent = GetAppropriateTopLevelParent();
GameTooltip_SetDefaultAnchor(tooltip, topLevelParent);
GameTooltip_SetTitle(tooltip, self.tooltip);
if ( self.tooltipText ) then
GameTooltip_AddBodyLine(tooltip, self.tooltipText);
end
tooltip:Show();
end
end
function ModelSceneControlButtonMixin:OnLeave()
self:GetParent():SetAlpha(0.5);
local tooltip = GetAppropriateTooltip();
tooltip:Hide();
end
--------------------------------------------------
-- MODEL ZOOM BUTTON MIXIN
ModelSceneZoomButtonMixin = CreateFromMixins(ModelSceneControlButtonMixin);
function ModelSceneZoomButtonMixin:OnLoad()
self.zoomAmount = 0;
end
function ModelSceneZoomButtonMixin:Init()
if self.zoomAmount < 0 then
ModelSceneControlButtonMixin.Init(self, "AnyUp", "common-icon-zoomout", ZOOM_OUT, KEY_MOUSEWHEELDOWN);
else
ModelSceneControlButtonMixin.Init(self, "AnyUp", "common-icon-zoomin", ZOOM_IN, KEY_MOUSEWHEELUP);
end
end
function ModelSceneZoomButtonMixin:SetZoomAmount(amountToZoom)
self.zoomAmount = amountToZoom;
end
function ModelSceneZoomButtonMixin:OnClick()
if self.modelScene then
self.modelScene:OnMouseWheel(self.zoomAmount);
else
assertsafe(fale, "Model Scene not specified");
end
PlaySound(SOUNDKIT.IG_INVENTORY_ROTATE_CHARACTER);
end
--------------------------------------------------
-- MODEL SCENE ROTATE BUTTON MIXIN
ModelScenelRotateButtonMixin = CreateFromMixins(ModelSceneControlButtonMixin);
function ModelScenelRotateButtonMixin:OnLoad()
ModelSceneControlButtonMixin.OnLoad(self);
self.rotateDirection = "none";
end
function ModelScenelRotateButtonMixin:Init()
if (self.rotateDirection == "left") then
ModelSceneControlButtonMixin.Init(self, "AnyUp", "common-icon-rotateleft", ROTATE_LEFT, ROTATE_TOOLTIP);
elseif (self.rotateDirection == "right") then
ModelSceneControlButtonMixin.Init(self, "AnyUp", "common-icon-rotateright", ROTATE_RIGHT, ROTATE_TOOLTIP);
else
assertsafe(false, "Invalid rotation specified: "..tostring(self.rotateDirection));
end
end
function ModelScenelRotateButtonMixin:SetRotation(rotation)
self.rotateDirection = rotation;
end
function ModelScenelRotateButtonMixin:SetRotationIncrement(increment)
self.rotationIncrement = increment or 0.05;
end
function ModelScenelRotateButtonMixin:OnMouseDown()
ModelSceneControlButtonMixin.OnMouseDown(self);
if self.modelScene then
self.modelScene:AdjustCameraYaw(self.rotateDirection, self.rotationIncrement);
else
assertsafe(false, "Model Scene not specified");
end
PlaySound(SOUNDKIT.IG_INVENTORY_ROTATE_CHARACTER);
end
function ModelScenelRotateButtonMixin:OnMouseUp()
ModelSceneControlButtonMixin.OnMouseUp(self);
if self.modelScene then
self.modelScene:StopCameraYaw();
end
end
function ModelScenelRotateButtonMixin:OnSmartNavClick()
self:RotateStep();
end
function ModelScenelRotateButtonMixin:RotateStep()
local camera = self.modelScene and self.modelScene:GetActiveCamera();
if not camera then
return;
end
if self.rotateDirection == "left" then
camera:AdjustYaw(-1, -1, 0.25);
else
camera:AdjustYaw(1, 1, 0.25);
end
end
--------------------------------------------------
-- MODEL SCENE RESET BUTTON MIXIN
ModelSceneResetButtonMixin = CreateFromMixins(ModelSceneControlButtonMixin);
function ModelSceneResetButtonMixin:OnLoad()
ModelSceneControlButtonMixin.OnLoad(self);
end
function ModelSceneResetButtonMixin:Init()
local tooltipText = nil;
ModelSceneControlButtonMixin.Init(self, "AnyUp", "common-icon-undo", RESET_POSITION, tooltipText);
end
function ModelSceneResetButtonMixin:OnClick()
if self.modelScene then
self.modelScene:Reset();
else
assertsafe(false, "Model Scene not specified");
end
PlaySound(SOUNDKIT.IG_INVENTORY_ROTATE_CHARACTER);
end