Skip to content

Commit d44c924

Browse files
authored
Update README.md
1 parent 3dd0ffa commit d44c924

File tree

1 file changed

+40
-24
lines changed

1 file changed

+40
-24
lines changed

README.md

+40-24
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22

33
Return unit frame for a given unit
44

5-
Usage :
6-
```
5+
## Usage
6+
7+
```Lua
78
local LGF = LibStub("LibGetFrame-1.0")
89
local frame = LGF.GetFrame(unit , options)
910
```
1011

11-
options :
12+
## Options
1213

13-
- framePriorities : array, default :
14-
```
14+
- framePriorities : array, default :
15+
16+
```Lua
1517
{
1618
-- raid frames
1719
[1] = "^Vd1", -- vuhdo
@@ -43,11 +45,13 @@ options :
4345
[25] = "^PlayerFrame",
4446
}
4547
```
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
5155
{
5256
"SUFUnitplayer",
5357
"PitBull4_Frames_Player",
@@ -56,8 +60,10 @@ options :
5660
"PlayerFrame",
5761
}
5862
```
59-
- targetFrames : array, default :
60-
```
63+
64+
- targetFrames : array, default :
65+
66+
```Lua
6167
{
6268
"SUFUnittarget",
6369
"PitBull4_Frames_Target",
@@ -66,8 +72,10 @@ options :
6672
"oUF_TukuiTarget",
6773
}
6874
```
69-
- targettargetFrames : array, default :
70-
```
75+
76+
- targettargetFrames : array, default :
77+
78+
```Lua
7179
{
7280
"SUFUnittargetarget",
7381
"PitBull4_Frames_TargetTarget",
@@ -76,16 +84,20 @@ options :
7684
"oUF_TukuiTargetTarget",
7785
}
7886
```
79-
- ignoreFrames : array, default :
80-
```
87+
88+
- ignoreFrames : array, default :
89+
90+
```Lua
8191
{ }
8292
```
83-
- returnAll : boolean (default false)
8493

85-
Example :
94+
- returnAll : boolean (default false)
8695

87-
Glow player frame
88-
```
96+
## Examples
97+
98+
### Glow player frame
99+
100+
```Lua
89101
local LGF = LibStub("LibGetFrame-1.0")
90102
local LCG = LibStub("LibCustomGlow-1.0")
91103
local frame = LGF.GetFrame("player")
@@ -96,8 +108,9 @@ if frame then
96108
end
97109
```
98110

99-
Glow every frames for your target
100-
```
111+
### Glow every frames for your target
112+
113+
```Lua
101114
local LGF = LibStub("LibGetFrame-1.0")
102115
local LCG = LibStub("LibCustomGlow-1.0")
103116

@@ -114,9 +127,12 @@ for _, frame in pairs(frames) do
114127
end
115128
```
116129

117-
Ignore Vuhdo panel 2 and 3
118-
```
130+
### Ignore Vuhdo panel 2 and 3
131+
132+
```Lua
119133
local frame = LGF.GetFrame("player", {
120134
ignoreFrames = { "Vd2.*", "Vd3.*" }
121135
})
122136
```
137+
138+
[GitHub Project](https://github.com/mrbuds/LibGetFrame)

0 commit comments

Comments
 (0)