Get an Epic Experience with Premium

LibSink-2.0

Libraries Login to Add Favorites
  • 0 Likes
  • World of Warcraft
  • 1,024 Monthly Downloads
  • Supports: 5.4.0
  • 528,670 Total Downloads
  • Updated 10/08/2013
  • Created 09/26/2008
  • 76 Favorites
  • Project Site
  • Release Type: Release
  • License: CC BY-NC-SA 3.0
  • Newest File: r98-release
or
Support development! **
Donate

About 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.

------------------------------------------------------------------------
r98 | funkydude | 2013-10-08 18:46:10 +0000 (Tue, 08 Oct 2013) | 1 line
Changed paths:
   A /tags/r98-release (from /trunk:97)

Tagging as r98-release
------------------------------------------------------------------------
r97 | funkydude | 2013-10-08 00:04:37 +0000 (Tue, 08 Oct 2013) | 1 line
Changed paths:
   M /trunk/LibSink-2.0/LibSink-2.0.lua

Fix printing to global channels. GetChannelName doesn't appear to work with channel names anymore, it seems to require the full "Channel - Zone", so use channel ids instead.
------------------------------------------------------------------------
r95 | funkydude | 2013-09-09 23:20:11 +0000 (Mon, 09 Sep 2013) | 1 line
Changed paths:
   M /trunk/LibSink-2.0.toc

bump toc
------------------------------------------------------------------------
r94 | funkydude | 2013-07-07 00:17:41 +0000 (Sun, 07 Jul 2013) | 2 lines
Changed paths:
   M /trunk/LibSink-2.0/LibSink-2.0.lua

Fix MSBT output
Fix broken scrollAreaFunc verification in :RegisterSink
------------------------------------------------------------------------

Login to Curse

Don't have an account? Create One.

Get an epic experience with Curse Premium
  • Faster addon downloads
  • Premium-Only Beta Giveaways
  • Ad-Free Curse experience
  • Premium Curse Client
  • and many More Features
  • Learn More »

Landmark Beta Key Giveaway!

Get My Code!