Vector2DMixin:GetXY()

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ FrameXML Funcs

→ FrameXML Docs

These functions are implemented in :GetXY FrameXML/Vector2D.lua and FrameXML/Vector3D.lua.

Defines and returns a vector's Cartesian coordinates.

x, y = vector:GetXY()
x, y, z = vector:GetXYZ()
vector:SetXY(x, y)
vector:SetXYZ(x, y, z)

Parameters

x, y, z

number - Cartesian coordinates.

Details

• Vector2DMixin uses GetXY() and SetXY().
• Vector3DMixin uses GetXYZ() and SetXYZ().
• Despite similarities, these two mixins are not compatible with each other. They must be manually converted or projected by copying coordinate values from one type to another.

Examples

Manually converting a 2D vector to 3D:

local x, y = vector2d:GetXY()
local vector3d = CreateFromMixins(Vector3DMixin)
vector3d:SetXYZ(x, y, 0)

Manually projecting a 3D vector to 2D:

local x, y, z = vector3d:GetXYZ()
local vector2d = CreateFromMixins(Vector2DMixin)
vector3d:SetXY(x, y)

See also

• CreateVector2D(x,y) - Creates a new vector and applies SetXY.
• CreateVector3D(x,y,z) - Creates a new vector and applies SetXYZ.

Patch changes

• Patch 7.2.0 (2017-03-28): Added.