2
2
3
3
Return unit frame for a given unit
4
4
5
- Usage :
6
- ```
5
+ ## Usage
6
+
7
+ ``` Lua
7
8
local LGF = LibStub (" LibGetFrame-1.0" )
8
9
local frame = LGF .GetFrame (unit , options )
9
10
```
10
11
11
- options :
12
+ ## Options
12
13
13
- - framePriorities : array, default :
14
- ```
14
+ - framePriorities : array, default :
15
+
16
+ ``` Lua
15
17
{
16
18
-- raid frames
17
19
[1 ] = " ^Vd1" , -- vuhdo
@@ -43,11 +45,13 @@ options :
43
45
[25 ] = " ^PlayerFrame" ,
44
46
}
45
47
```
46
- - ignorePlayerFrame : boolean (default true)
47
- - ignoreTargetFrame : boolean (default true)
48
- - ignoreTargettargetFrame : boolean (default true)
49
- - playerFrames : array, default :
50
- ```
48
+
49
+ - ignorePlayerFrame : boolean (default true)
50
+ - ignoreTargetFrame : boolean (default true)
51
+ - ignoreTargettargetFrame : boolean (default true)
52
+ - playerFrames : array, default :
53
+
54
+ ``` Lua
51
55
{
52
56
" SUFUnitplayer" ,
53
57
" PitBull4_Frames_Player" ,
@@ -56,8 +60,10 @@ options :
56
60
" PlayerFrame" ,
57
61
}
58
62
```
59
- - targetFrames : array, default :
60
- ```
63
+
64
+ - targetFrames : array, default :
65
+
66
+ ``` Lua
61
67
{
62
68
" SUFUnittarget" ,
63
69
" PitBull4_Frames_Target" ,
@@ -66,8 +72,10 @@ options :
66
72
" oUF_TukuiTarget" ,
67
73
}
68
74
```
69
- - targettargetFrames : array, default :
70
- ```
75
+
76
+ - targettargetFrames : array, default :
77
+
78
+ ``` Lua
71
79
{
72
80
" SUFUnittargetarget" ,
73
81
" PitBull4_Frames_TargetTarget" ,
@@ -76,16 +84,20 @@ options :
76
84
" oUF_TukuiTargetTarget" ,
77
85
}
78
86
```
79
- - ignoreFrames : array, default :
80
- ```
87
+
88
+ - ignoreFrames : array, default :
89
+
90
+ ``` Lua
81
91
{ }
82
92
```
83
- - returnAll : boolean (default false)
84
93
85
- Example :
94
+ - returnAll : boolean (default false)
86
95
87
- Glow player frame
88
- ```
96
+ ## Examples
97
+
98
+ ### Glow player frame
99
+
100
+ ``` Lua
89
101
local LGF = LibStub (" LibGetFrame-1.0" )
90
102
local LCG = LibStub (" LibCustomGlow-1.0" )
91
103
local frame = LGF .GetFrame (" player" )
@@ -96,8 +108,9 @@ if frame then
96
108
end
97
109
```
98
110
99
- Glow every frames for your target
100
- ```
111
+ ### Glow every frames for your target
112
+
113
+ ``` Lua
101
114
local LGF = LibStub (" LibGetFrame-1.0" )
102
115
local LCG = LibStub (" LibCustomGlow-1.0" )
103
116
@@ -114,9 +127,12 @@ for _, frame in pairs(frames) do
114
127
end
115
128
```
116
129
117
- Ignore Vuhdo panel 2 and 3
118
- ```
130
+ ### Ignore Vuhdo panel 2 and 3
131
+
132
+ ``` Lua
119
133
local frame = LGF .GetFrame (" player" , {
120
134
ignoreFrames = { " Vd2.*" , " Vd3.*" }
121
135
})
122
136
```
137
+
138
+ [ GitHub Project] ( https://github.com/mrbuds/LibGetFrame )
0 commit comments