Simple position.

[Bleckpan]

In my addon here, I am trying to figure out how to save the position of where it was before the character logged out. (I attached an attachment just for good measure)

I am new to programming addons, and I can't find just a simple way to save the position so that I can recall it when they log back in. So, how can I save the position and then have the frame go back to that position when you log in?

Please just give me the basics of how to do this if you can.
Thanks in advance.

[Xrystal]

If you are meaning the position of the frame for the addon then for the most part it is automatically saved and restored. The following is what I have been using for most if not all of my addons recently. Just place the functions at the top of your addon and call them as needed.

--[[ Handle simple movement of the appropriate frame ]]--
local function StartMoving(self,button)
  if ( button ~= "LeftButton" ) then return end
  if ( ( not self.isLocked ) or ( self.isLocked == 0 ) ) then
    if ( self:IsMovable() ) then
      self:StartMoving();
      self.isMoving = true;
      self.hasMoved = false;
    end
  end
end

--[[ Handle stopping movement for the appropriate frame  ]]--
local function StopMoving(self,button)
  if ( button ~= "LeftButton" ) then return end
  if ( self.isMoving ) then
    self:StopMovingOrSizing();
    self.isMoving = false;
    self.hasMoved = true;
  end
end	

--[[ Unlock the frame so it can be moved.  ]]--
local function UnLock(frame)
  frame.isLocked = false;
  frame:RegisterForDrag("LeftButton");
  frame:EnableMouse(true);
  frame:SetMovable(true);	
  frame:SetScript("OnMouseDown",StartMoving);
  frame:SetScript("OnMouseUp",StopMoving);
  frame:SetScript("OnHide",StopMoving);
end

--[[ Lock the frame from movement ]]--
local function LockFrame (frame)
  frame.isLocked = true;
  frame:RegisterForDrag(nil);
  frame:EnableMouse(false);
  frame:SetMovable(false);
  frame:SetScript("OnMouseDown",nil);
  frame:SetScript("OnMouseUp",nil);
  frame:SetScript("OnHide",nil);
end

And here is an example of the functions in use:

local function InitialiseFrame()
  local frame = CreateFrame("Frame","MyUniqueFrameName",UIParent);
  frame:SetAlpha(1.0);        
  frame:SetClampedToScreen(true);
  UnLock(frame);
  SetBackDrop(frame);
  InitialiseContents(frame);	
  PositionFrame(frame);
  ResizeFrame(frame);
  ScaleFrame(frame);
  return frame;
end

local function OnEvent(self,event,...)
  if ( event == "ADDON_LOADED" ) then
    if ( arg1 == addonName ) then
      myUniqueFrame = InitialiseFrame(); 	
    end
  elseif ( event == "VARIABLES_LOADED" ) then
    PositionFrame(myUniqueFrame);
  end
end

If you want more control though such as storing the position of the frame yourself and restoring it you need to reposition after the VARIABLES_LOADED event is triggered as at this point blizzard has done the automatic positioning of all frames it has internally kept track of. Despite having access to your own addons WTF data when ADDON_LOADED event is triggered the positioning is adjusted internally which is possibly what you are seeing. It took me a long while to get that through my head.

Hopefully this will help you get that part of your addon down so you can concentrate on the rest of the functionality.

[Slakah]

You might want to be careful with your comment syntax Xrystal

[Xrystal]

Originally Posted by Slakah You might want to be careful with your comment syntax Xrystal

Oh ? I know they can't be nested but I use --[[ ]]-- only above function declarations and -- for inside them.

Anything else that I should be aware of with that style of comment ?

[Bleckpan]

So what you are saying is that when you lock the frame, it will stay right where it is if you were to log out and back in, so it is saved automatically?

[Xrystal]

Yep. The scripts OnMouseDown/OnMouseUp automatically handle saving position of the frames and gets automatically restored once blizzard updates its own information regarding the frame.

If you choose to Lock the frame it will be immovable by the user once you position it. So you would either position it specifically somewhere and use the Lock function to keep it there or use the UnLock function to allow the user to move the frame where they want and let Blizzard keep track of it for you. Of course you can keep track yourself but that will include quite a few more blocks of code to enforce the store and restore of positioning information.

[Bleckpan]

So, in the first line right here, I need to replace (frame) with the name of the frame, right?

local function LockFrame (frame)
  frame.isLocked = true;
  frame:RegisterForDrag(nil);
  frame:EnableMouse(false);
  frame:SetMovable(false);
  frame:SetScript("OnMouseDown",nil);
  frame:SetScript("OnMouseUp",nil);
  frame:SetScript("OnHide",nil);
end

Oh, never mind, that is the variable frame.

[Cralor]

Originally Posted by Xrystal Oh ? I know they can't be nested but I use --[[ ]]-- only above function declarations and -- for inside them. Anything else that I should be aware of with that style of comment ?

A multi-lined comment is "-- [[ ]]". This is what Slakah may be referring to. Your ending "--" might cause problems in uncareful situations. (Easy fix though.)

I don't know what else he might be referring to.

[Xrystal]

Originally Posted by Cralor A multi-lined comment is "-- [[ ]]". This is what Slakah may be referring to. Your ending "--" might cause problems in uncareful situations. (Easy fix though.) I don't know what else he might be referring to.

Ah yeah, I saw alot of examples without the -- but saw that the way I am using it didn't have any problems. It just seems imbalanced without the extra -- rofl but yeah, like you said if it causes a problem I can simply remove the --

[Bleckpan]

Well, now it is broke, but thanks for the help anyways.

[Cralor]

Originally Posted by Xrystal Ah yeah, I saw alot of examples without the -- but saw that the way I am using it didn't have any problems. It just seems imbalanced without the extra -- rofl but yeah, like you said if it causes a problem I can simply remove the --

Yeah. I understand! Symmetrical things look nicer!

[Bleckpan]

Got it fixed now, thank you so much for your help, I'll give proper credit to you...