WoW:API Frame SetBackdrop: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
(Document arguments)
Line 1: Line 1:
== Syntax ==
{{widgetmethod}}


  Frame:SetBackdrop({bgFile = "bgFile", edgeFile = "edgeFile", tile = false, tileSize = 0, edgeSize = 32, insets = { left = 0, right = 0, top = 0, bottom = 0 }});
 
  Frame:SetBackdrop( {  
  bgFile = "bgFile",  
  edgeFile = "edgeFile", tile = false, tileSize = 0, edgeSize = 32,  
  insets = { left = 0, right = 0, top = 0, bottom = 0 }
});




Using 'nil' as the only parameter will remove the backdrop on the indicated frame.
Using 'nil' as the only parameter will remove the backdrop on the indicated frame.
== Arguments ==
:;bgFile:String - Which texture file to use as frame background (.blp or .tga format)
:;[[edgeFiles|edgeFile]]:String- Which texture file to use as frame edge blp or .tga format)
:;tile:Boolean - ?
:;tileSize:Number - Control how large each copy of the bgFile becomes on-screen
:;edgeSize:Number - Control how large each copy of the edgeFile becomes on-screen (i.e. border thickness and corner size)
:;insets:4 x Number - Controls how far into the frame the background will be drawn (use higher values the thicker the edges are)


== Example ==
== Example ==
Line 12: Line 25:
                                             insets = { left = 0, right = 0, top = 0, bottom = 0 }});
                                             insets = { left = 0, right = 0, top = 0, bottom = 0 }});


 
== See Also ==
{{template:WoW API}}
* [[edgeFiles]]
* [[API SetBackdropColor|SetBackdropColor]]
* [[API SetBackdropBorderColor|SetBackdropBorderColor]]

Revision as of 09:16, 14 July 2006

← Widget API ← Frame < SetBackdrop 


Frame:SetBackdrop( { 
  bgFile = "bgFile", 
  edgeFile = "edgeFile", tile = false, tileSize = 0, edgeSize = 32, 
  insets = { left = 0, right = 0, top = 0, bottom = 0 }
});


Using 'nil' as the only parameter will remove the backdrop on the indicated frame.

Arguments

bgFile
String - Which texture file to use as frame background (.blp or .tga format)
edgeFile
String- Which texture file to use as frame edge blp or .tga format)
tile
Boolean - ?
tileSize
Number - Control how large each copy of the bgFile becomes on-screen
edgeSize
Number - Control how large each copy of the edgeFile becomes on-screen (i.e. border thickness and corner size)
insets
4 x Number - Controls how far into the frame the background will be drawn (use higher values the thicker the edges are)

Example

MinimapCluster:SetBackdrop({bgFile = "Interface/Tooltips/UI-Tooltip-Background", 
                                            edgeFile = "Interface/Tooltips/UI-Tooltip-Border", 
                                            tile = true, tileSize = 32, edgeSize = 32, 
                                            insets = { left = 0, right = 0, top = 0, bottom = 0 }});

See Also

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_Frame_SetBackdrop&oldid=11447"