Advertisement
Guest User

Untitled

a guest
Jun 7th, 2011
3,706
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 20.49 KB | None | 0 0
  1. Basic globals:
  2. Development.Documentation
  3. UI.CreateContext
  4. UI.CreateFrame
  5. _VERSION
  6. assert
  7. bit.arshift
  8. bit.band
  9. bit.bnot
  10. bit.bor
  11. bit.bswap
  12. bit.bxor
  13. bit.lshift
  14. bit.rol
  15. bit.ror
  16. bit.rshift
  17. bit.tobit
  18. bit.tohex
  19. collectgarbage
  20. coroutine.create
  21. coroutine.resume
  22. coroutine.running
  23. coroutine.status
  24. coroutine.wrap
  25. coroutine.yield
  26. debug.traceback
  27. error
  28. gcinfo
  29. getfenv
  30. getmetatable
  31. ipairs
  32. load
  33. loadstring
  34. math.abs
  35. math.acos
  36. math.asin
  37. math.atan
  38. math.atan2
  39. math.ceil
  40. math.cos
  41. math.cosh
  42. math.deg
  43. math.exp
  44. math.floor
  45. math.fmod
  46. math.frexp
  47. math.huge
  48. math.ldexp
  49. math.log
  50. math.log10
  51. math.max
  52. math.min
  53. math.mod
  54. math.modf
  55. math.pi
  56. math.pow
  57. math.rad
  58. math.random
  59. math.randomseed
  60. math.sin
  61. math.sinh
  62. math.sqrt
  63. math.tan
  64. math.tanh
  65. newproxy
  66. next
  67. pairs
  68. pcall
  69. print
  70. print_console
  71. rawequal
  72. rawget
  73. rawset
  74. select
  75. setfenv
  76. setmetatable
  77. string.byte
  78. string.char
  79. string.find
  80. string.format
  81. string.gfind
  82. string.gmatch
  83. string.gsub
  84. string.len
  85. string.lower
  86. string.match
  87. string.rep
  88. string.reverse
  89. string.sub
  90. string.upper
  91. table.concat
  92. table.foreach
  93. table.foreachi
  94. table.getn
  95. table.insert
  96. table.maxn
  97. table.remove
  98. table.sort
  99. tonumber
  100. tostring
  101. type
  102. unpack
  103. xpcall
  104. Inspectors:
  105. Inspect.Addon.Cpu
  106. Inspect.Addon.Current
  107. Inspect.Buff.Detail
  108. Inspect.Buff.List
  109. Inspect.System.Time
  110. Commands:
  111. Command.Buff.Cancel
  112. Command.Slash.Register
  113. Events:
  114. Event.Addon.Finalizing
  115. Event.Addon.Load.Begin
  116. Event.Addon.Load.End
  117. Event.Addon.SavedVariables.Load.Begin
  118. Event.Addon.SavedVariables.Load.End
  119. Event.Addon.SavedVariables.Save.Begin
  120. Event.Addon.SavedVariables.Save.End
  121. Event.Addon.Shutdown
  122. Event.Addon.Starting
  123. Event.Slash (empty category for dynamically-created events)
  124. Event.System.Error
  125. (1 handler)
  126. Event.System.Update.Begin
  127. Event.System.Update.End
  128. (1 handler)
  129. UI:
  130. Layout:
  131. Members:
  132. GetBottom
  133. GetBounds
  134. GetEventTable
  135. GetHeight
  136. GetLeft
  137. GetName
  138. GetOwner
  139. GetRight
  140. GetTop
  141. GetWidth
  142. Events:
  143. Move
  144. Size
  145. Frame: Inherits from Layout
  146. Members:
  147. GetAlpha
  148. GetBackgroundColor
  149. GetLayer
  150. GetParent
  151. GetVisible
  152. SetAllPoints
  153. SetAlpha
  154. SetBackgroundColor
  155. SetHeight
  156. SetLayer
  157. SetParent
  158. SetPoint
  159. SetVisible
  160. SetWidth
  161. Events:
  162. LeftDown
  163. LeftUp
  164. Context: Inherits from Frame
  165. Members:
  166. (No extra members)
  167. Events:
  168. (No extra events)
  169. Text: Inherits from Frame
  170. Members:
  171. GetFont
  172. GetFontColor
  173. GetFontSize
  174. GetFullHeight
  175. GetFullWidth
  176. GetText
  177. GetWordwrap
  178. ResizeToText
  179. SetFont
  180. SetFontColor
  181. SetFontSize
  182. SetText
  183. SetWordwrap
  184. Events:
  185. (No extra events)
  186. Texture: Inherits from Frame
  187. Members:
  188. GetTexture
  189. GetTextureHeight
  190. GetTextureWidth
  191. ResizeToTexture
  192. SetTexture
  193. Events:
  194. (No extra events)
  195.  
  196. Basic globals:
  197. Development.Documentation
  198. Provide documentation on items in the addon environment. Called with no parameters, it returns a table listing all documentation. Can provide both human-readable and computer-readable documentation.
  199. documentables = Development.Documentation() -- table <- void
  200. documentation = Development.Documentation(item) -- string <- variant
  201. documentation = Development.Documentation(item, parseable = false) -- string <- variant, boolean
  202. documentationTable = Development.Documentation(item, parseable = true) -- table <- variant, boolean
  203. Parameters:
  204. parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format.
  205. item: The item to get documentation on. May be either the item itself or a string identifier.
  206. Results:
  207. documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format.
  208. documentationTable: Computer-readable documentation for the requested item. Format may change without warning.
  209. documentation: Documentation for the requested item.
  210. UI.CreateContext
  211. Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
  212. frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Frame
  213. Parameters:
  214. name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
  215. parent: The new parent for this frame.
  216. type: The type of your new frame. Current supported types: Frame, Text, Texture.
  217. Results:
  218. frame: Your new frame.
  219. UI.CreateFrame
  220. Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
  221. frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Frame
  222. Parameters:
  223. name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
  224. parent: The new parent for this frame.
  225. type: The type of your new frame. Current supported types: Frame, Text, Texture.
  226. Results:
  227. frame: Your new frame.
  228. _VERSION
  229. assert
  230. bit.arshift
  231. bit.band
  232. bit.bnot
  233. bit.bor
  234. bit.bswap
  235. bit.bxor
  236. bit.lshift
  237. bit.rol
  238. bit.ror
  239. bit.rshift
  240. bit.tobit
  241. bit.tohex
  242. collectgarbage
  243. coroutine.create
  244. coroutine.resume
  245. coroutine.running
  246. coroutine.status
  247. coroutine.wrap
  248. coroutine.yield
  249. debug.traceback
  250. error
  251. gcinfo
  252. getfenv
  253. getmetatable
  254. ipairs
  255. load
  256. loadstring
  257. math.abs
  258. math.acos
  259. math.asin
  260. math.atan
  261. math.atan2
  262. math.ceil
  263. math.cos
  264. math.cosh
  265. math.deg
  266. math.exp
  267. math.floor
  268. math.fmod
  269. math.frexp
  270. math.huge
  271. math.ldexp
  272. math.log
  273. math.log10
  274. math.max
  275. math.min
  276. math.mod
  277. math.modf
  278. math.pi
  279. math.pow
  280. math.rad
  281. math.random
  282. math.randomseed
  283. math.sin
  284. math.sinh
  285. math.sqrt
  286. math.tan
  287. math.tanh
  288. newproxy
  289. next
  290. pairs
  291. pcall
  292. print
  293. print_console
  294. rawequal
  295. rawget
  296. rawset
  297. select
  298. setfenv
  299. setmetatable
  300. string.byte
  301. string.char
  302. string.find
  303. string.format
  304. string.gfind
  305. string.gmatch
  306. string.gsub
  307. string.len
  308. string.lower
  309. string.match
  310. string.rep
  311. string.reverse
  312. string.sub
  313. string.upper
  314. table.concat
  315. table.foreach
  316. table.foreachi
  317. table.getn
  318. table.insert
  319. table.maxn
  320. table.remove
  321. table.sort
  322. tonumber
  323. tostring
  324. type
  325. unpack
  326. xpcall
  327. Inspectors:
  328. Inspect.Addon.Cpu
  329. Returns recent CPU usage information. This is calculated using an exponential-falloff method.
  330. data = Inspect.Addon.Cpu() -- table <- void
  331. Results:
  332. data: Recent CPU usage. This takes the format { AddonIdentifier = { SubIdentifier = cpu_used_as_a_fraction_of_one } }. SubIdentifiers are generated by Rift and the format may change without notice.
  333. Inspect.Addon.Current
  334. Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
  335. addonIdentifier = Inspect.Addon.Current() -- string <- void
  336. Results:
  337. addonIdentifier: The addon's identifier, as written in its TOC file.
  338. Inspect.Buff.Detail
  339. Provides detailed information about the buffs on a unit.
  340. detail = Inspect.Buff.Detail(unit, buff) -- table <- string, string
  341. details = Inspect.Buff.Detail(unit, buffs) -- table <- string, table
  342. Parameters:
  343. buff: An identifier for the buff to retrieve detail for.
  344. buffs: A table containing buff identifiers to retrieve details for.
  345. unit: The unit to inspect.
  346. Results:
  347. detail: Detail table for a single buff. May include members: name, ability, rune, buff, debuff, noncancelable, duration, remaining, expired, stack, caster.
  348. details: Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
  349. Inspect.Buff.List
  350. List buffs on a unit.
  351. buffs = Inspect.Buff.List(unit) -- table <- string
  352. Parameters:
  353. unit: The unit to inspect.
  354. Results:
  355. buffs: List of IDs of the buffs on the unit.
  356. Inspect.System.Time
  357. A high-resolution timer.
  358. time = Inspect.System.Time() -- number <- void
  359. Results:
  360. time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
  361. Commands:
  362. Command.Buff.Cancel
  363. Cancels a buff on the player. Not all buffs are cancelable.
  364. Command.Buff.Cancel(buff) -- string
  365. Parameters:
  366. buff: The ID of the buff to cancel.
  367. Command.Slash.Register
  368. Registers a new chat slash command, inserts a new event table into the Event.Slash hierarchy, and returns that table. If called multiple times with the same slash command, will return the same table each time.
  369. eventTable = Command.Slash.Register(slashCommand) -- table <- string
  370. Parameters:
  371. slashCommand: The name of the slash command to register.
  372. Results:
  373. eventTable: The event table for your slash command. nil if the slash command could not be registered (usually because it conflicts with a built-in slash command.)
  374. Events:
  375. Event.Addon.Finalizing
  376. Event.Addon.Load.Begin
  377. Event.Addon.Load.End
  378. Event.Addon.SavedVariables.Load.Begin
  379. Event.Addon.SavedVariables.Load.End
  380. Event.Addon.SavedVariables.Save.Begin
  381. Event.Addon.SavedVariables.Save.End
  382. Event.Addon.Shutdown
  383. Event.Addon.Starting
  384. Event.Slash (empty category for dynamically-created events)
  385. Event.System.Error
  386. (1 handler)
  387. Event.System.Update.Begin
  388. Event.System.Update.End
  389. (1 handler)
  390. UI:
  391. Layout:
  392. Members:
  393. GetBottom
  394. Retrieves the Y position of the bottom edge of this element.
  395. bottom = Layout:GetBottom() -- number <- void
  396. Results:
  397. bottom: The Y position of the bottom edge of this element.
  398. GetBounds
  399. Retrieves the complete bounds of this element.
  400. left, top, right, bottom = Layout:GetBounds() -- number, number, number, number <- void
  401. Results:
  402. right: The X position of the right edge of this element.
  403. left: The X position of the left edge of this element.
  404. bottom: The Y position of the bottom edge of this element.
  405. top: The Y position of the top edge of this element.
  406. GetEventTable
  407. Retrieves the event table of this element. By default, this value is also stored in "this.Event".
  408. eventTable = Layout:GetEventTable() -- table <- void
  409. Results:
  410. eventTable: The event table of this element.
  411. GetHeight
  412. Retrieves the height of this element.
  413. height = Layout:GetHeight() -- number <- void
  414. Results:
  415. height: The height of this element.
  416. GetLeft
  417. Retrieves the X position of the left edge of this element.
  418. left = Layout:GetLeft() -- number <- void
  419. Results:
  420. left: The X position of the left edge of this element.
  421. GetName
  422. Retrieves the name of this element.
  423. name = Layout:GetName() -- string <- void
  424. Results:
  425. name: The name of this element, as provided by the addon that created it.
  426. GetOwner
  427. Retrieves the owner of this element.
  428. owner = Layout:GetOwner() -- string <- void
  429. Results:
  430. owner: The owner of this element. Given as an addon identifier.
  431. GetRight
  432. Retrieves the X position of the right edge of this element.
  433. right = Layout:GetRight() -- number <- void
  434. Results:
  435. right: The X position of the right edge of this element.
  436. GetTop
  437. Retrieves the Y position of the top edge of this element.
  438. top = Layout:GetTop() -- number <- void
  439. Results:
  440. top: The Y position of the top edge of this element.
  441. GetWidth
  442. Retrieves the width of this element.
  443. width = Layout:GetWidth() -- number <- void
  444. Results:
  445. width: The width of this element.
  446. Events:
  447. Move
  448. Size
  449. Frame: Inherits from Layout
  450. Members:
  451. GetAlpha
  452. Gets the alpha multiplier of this frame.
  453. alpha = Frame:GetAlpha() -- number <- void
  454. Results:
  455. alpha: The alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.
  456. GetBackgroundColor
  457. Retrieves the background color of this frame.
  458. r, g, b, a = Frame:GetBackgroundColor() -- number, number, number, number <- void
  459. Results:
  460. b: Blue.
  461. r: Red.
  462. a: Alpha. 1 is fully opaque, 0 is fully transparent.
  463. g: Green.
  464. GetLayer
  465. Gets the frame's layer order.
  466. layer = Frame:GetLayer() -- number <- void
  467. Results:
  468. layer: The render layer of this frame. See Frame:SetLayer for details.
  469. GetParent
  470. Gets the parent of this frame.
  471. parent = Frame:GetParent() -- Frame <- void
  472. Results:
  473. parent: The parent element of this frame.
  474. GetVisible
  475. Gets the visibility flag for this frame.
  476. visible = Frame:GetVisible() -- boolean <- void
  477. Results:
  478. visible: This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.
  479. SetAllPoints
  480. Pins all the edges of this frame to the edges of a different frame.
  481. Frame:SetAllPoints(target) -- Layout
  482. Parameters:
  483. target: Target Layout to pin this frame's edges to.
  484. SetAlpha
  485. Sets the alpha transparency multiplier for this frame and its children.
  486. Frame:SetAlpha(alpha) -- number
  487. Parameters:
  488. alpha: The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.
  489. SetBackgroundColor
  490. Sets the background color of this frame.
  491. Frame:SetBackgroundColor(r, g, b) -- number, number, number
  492. Frame:SetBackgroundColor(r, g, b, a) -- number, number, number, number
  493. Parameters:
  494. b: Blue.
  495. r: Red.
  496. a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
  497. g: Green.
  498. SetHeight
  499. Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
  500. Frame:SetHeight(height) -- number
  501. Parameters:
  502. height: The new height of this frame.
  503. SetLayer
  504. Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but stable during a single play session. Frames are always drawn after their parents.
  505. Frame:SetLayer(layer) -- number
  506. Parameters:
  507. layer: The new layer for this frame.
  508. SetParent
  509. Sets the parent of this frame. Circular dependencies result in undefined behavior.
  510. Frame:SetParent(parent) -- Frame
  511. Parameters:
  512. parent: The new parent for this frame.
  513. SetPoint
  514. Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it. Better documentation will be forthcoming.
  515. Frame:SetPoint(...) -- ...
  516. Parameters:
  517. ...: This function's parameters are complicated. More details will be forthcoming.
  518. SetVisible
  519. Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.
  520. Frame:SetVisible(visible) -- boolean
  521. Parameters:
  522. visible: The new visibility flag.
  523. SetWidth
  524. Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
  525. Frame:SetWidth(width) -- number
  526. Parameters:
  527. width: The new width of this frame.
  528. Events:
  529. LeftDown
  530. LeftUp
  531. Context: Inherits from Frame
  532. Members:
  533. (No extra members)
  534. Events:
  535. (No extra events)
  536. Text: Inherits from Frame
  537. Members:
  538. GetFont
  539. Gets the current font used for this element.
  540. source, font = Text:GetFont() -- string, string <- void
  541. Results:
  542. font: The actual font identifier. Either a resource identifier or a filename.
  543. source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
  544. GetFontColor
  545. Gets the current font color for this element.
  546. r, g, b, a = Text:GetFontColor() -- number, number, number, number <- void
  547. Results:
  548. b: Blue.
  549. r: Red.
  550. a: Alpha. 1 is fully opaque, 0 is fully transparent.
  551. g: Green.
  552. GetFontSize
  553. Gets the font size of the current element.
  554. fontsize = Text:GetFontSize() -- number <- void
  555. Results:
  556. fontsize: The current font size of this element.
  557. GetFullHeight
  558. Get the height that would be required for this element to display all lines of text.
  559. height = Text:GetFullHeight() -- number <- void
  560. Results:
  561. height: The element height needed to display all lines of text.
  562. GetFullWidth
  563. Get the width that would be required for this element to avoid word wrapping or truncation.
  564. width = Text:GetFullWidth() -- number <- void
  565. Results:
  566. width: The element width needed to avoid word wrapping or truncation.
  567. GetText
  568. Get the current text for this element.
  569. text = Text:GetText() -- string <- void
  570. Results:
  571. text: The current text of the element.
  572. GetWordwrap
  573. Gets the wordwrap flag for this element.
  574. wordwrap = Text:GetWordwrap() -- boolean <- void
  575. Results:
  576. wordwrap: The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
  577. ResizeToText
  578. Sets the element's width and height to display all text without wordwrapping or truncation.
  579. Text:ResizeToText() -- void
  580. SetFont
  581. Sets the current font used for this element.
  582. Text:SetFont(source, font) -- string, string
  583. Parameters:
  584. font: The actual font identifier. Either a resource identifier or a filename.
  585. source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
  586. SetFontColor
  587. Sets the current font color for this element.
  588. Text:SetFontColor(r, g, b) -- number, number, number
  589. Text:SetFontColor(r, g, b, a) -- number, number, number, number
  590. Parameters:
  591. b: Blue.
  592. r: Red.
  593. a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
  594. g: Green.
  595. SetFontSize
  596. Sets the current font size of this element.
  597. Text:SetFontSize(fontsize) -- number
  598. Parameters:
  599. fontsize: The new font size of this element.
  600. SetText
  601. Sets the current text for this element.
  602. Text:SetText(text) -- string
  603. Parameters:
  604. text: The new text for the element.
  605. SetWordwrap
  606. Sets the wordwrap flag for this element.
  607. Text:SetWordwrap(wordwrap) -- boolean
  608. Parameters:
  609. wordwrap: The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
  610. Events:
  611. (No extra events)
  612. Texture: Inherits from Frame
  613. Members:
  614. GetTexture
  615. Gets the current texture used for this element.
  616. source, texture = Texture:GetTexture() -- string, string <- void
  617. Results:
  618. source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
  619. texture: The actual texture identifier. Either a resource identifier or a filename.
  620. GetTextureHeight
  621. Returns the actual pixel height of the current texture.
  622. height = Texture:GetTextureHeight() -- number <- void
  623. Results:
  624. height: The height of the current texture in pixels.
  625. GetTextureWidth
  626. Returns the actual pixel width of the current texture.
  627. width = Texture:GetTextureWidth() -- number <- void
  628. Results:
  629. width: The width of the current texture in pixels.
  630. ResizeToTexture
  631. Sets the element's width and height to the exact pixel size of the texture.
  632. Texture:ResizeToTexture() -- void
  633. SetTexture
  634. Sets the current texture used for this element.
  635. Texture:SetTexture(source, texture) -- string, string
  636. Parameters:
  637. source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
  638. texture: The actual texture identifier. Either a resource identifier or a filename.
  639. Events:
  640. (No extra events)
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement