LibSink-2.0

LibSink-2.0 is a small library that you can throw in to easily get configuration options for your addon on where it should output any kind of messages.

By default, LibSink-2.0 supports several addons as output "sinks"; Blizzard floating combat text, MSBT, SCT, Parrot, BCF. And if that's not enough it can also route your output to any ingame channel, like raid warning, party chat, say. Or just to a local chatframe, UIErrorsFrame, etc.

In order to use LibSink-2.0 in your addon, you simply need to embed it into the addon object;

local addon = LibStub("AceAddon-3.0"):NewAddon("Bunnies!", "LibSink-2.0")

Then you get a few new methods on your addon object, most notably :Pour(...):

self:Pour(text, r, g, b, font, size, outline, sticky, location, icon)

The only ones you need to concern yourself with are usually text, r, g and b. These arguments say what text you want to output in and what color. RGB should be passed as decimal values ranging from 0.0 to 1.0.

The next thing you should note is that LibSink-2.0 provides a method on your addon object that you can invoke to produce options for configuring where, exactly, :Pour requests should be poured from your addon;

self:GetSinkAce3OptionsDataTable()
self:GetSinkAce2OptionsDataTable()

So obviously you use the one appropriate for your addon (probably Ace3 nowadays). If you already have an option table for your addon (which is very likely), you just insert the return value from this function into its own section in your config;

local options = {
    type = "group",
    name = "Bunny options!",
    args = {}
}
options.args.output = self:GetSinkAce3OptionsDataTable()

And, of course, LibSink-2.0 will need somewhere to store the users preferences about your addon, and since libraries can not have SavedVariables, you need to supply it;

self:SetSinkStorage(self.db.profile)

LibSink can potentially store a few different keys in your database, including sink20OutputSink, sink20Sticky and sink20ScrollArea.

Facts

Date created
Sep 26, 2008
Category
Last update
Oct 08, 2013
Development stage
Release
Language
  • deDE
  • enUS
  • esES
  • esMX
  • frFR
  • itIT
  • koKR
  • ptBR
  • ruRU
  • zhCN
  • zhTW
License
CC BY-NC-SA 3.0
Curse link
LibSink-2.0
Reverse relationships
66
Downloads
523,821
Recent files
  • R: r98-release for 5.4.0 Oct 08, 2013
  • A: r97 for 5.4.0 Oct 08, 2013
  • R: r96-release for 5.4.0 Sep 09, 2013
  • A: r95 for 5.4.0 Sep 09, 2013
  • A: r94 for 5.3.0 Jul 07, 2013

Authors