Soar-1.0

From WowAce Wiki
Jump to: navigation, search


Note: Soar is depricated. Use SinkLib instead.

Custom Color Custom Font Font Outlining Sticky Events
Parrot x x x x
MSBT x x x x
SCT x x
Blizzard x x


API Documentation

Note: This documentation is auto-generated. Please note that direct modifications may be overwritten on next autogenerate.

:RegisterSoarHandler(addonName , callback , enableCheck)

Arguments

addonName
type - (needs documentation)
callback
type - (needs documentation)
enableCheck
type - (needs documentation)


:SoarIncoming(text , r , g , b , font , size , outline , sticky , icon)

Arguments

text
type - (needs documentation)
r
type - (needs documentation)
g
type - (needs documentation)
b
type - (needs documentation)
font
type - (needs documentation)
size
type - (needs documentation)
outline
type - (needs documentation)
sticky
type - (needs documentation)
icon
type - (needs documentation)

Notes

An alias for :SoarMessage() with a location of "INCOMING"

Example

-- Sends a yellow message in the default font with a thick outline to the incoming text frame
self:SoarIncoming("Hello from my addon!")

int int int string boolean string string

:SoarMessage("text" [, r] [, g] [, b] [, font] [, size] [, outline] [, sticky] [, location] [, icon])

Arguments

"text"
string - text to show
r
int - red color value [0-1]
g
int - green color value [0-1]
b
int - blue color value [0-1]
font
string - "NORMAL", "OUTLINE", or "THICKOUTLINE"
size
boolean - indicate whether this should be a "sticky"/crit event
outline
string - "NOTIFY", "INCOMING", or "OUTGOING". Default is "NOTIFY"
sticky
string - an icon to show with the message. Note: only works with Parrot.
location
type - (needs documentation)
icon
type - (needs documentation)

Notes

Sends a floating message to the first supported addon found. If no location is specified, the message is sent to the notification frame (if available)

Returns

none

Example

-- Sends a yellow message in the default font with a thick outline to the notification frame
self:SoarMessage("Hello from my addon!", 1, 1, 0, nil, nil, "THICKOUTLINE", true, "NOTIFY")

:SoarNotify(text , r , g , b , font , size , outline , sticky , icon)

Arguments

text
type - (needs documentation)
r
type - (needs documentation)
g
type - (needs documentation)
b
type - (needs documentation)
font
type - (needs documentation)
size
type - (needs documentation)
outline
type - (needs documentation)
sticky
type - (needs documentation)
icon
type - (needs documentation)

Notes

An alias for :SoarMessage() with a location of "NOTIFY"

Example

-- Sends a yellow message in the default font with a thick outline to the notification frame
self:SoarNotify("Hello from my addon!")

:SoarOutgoing(text , r , g , b , font , size , outline , sticky , icon)

Arguments

text
type - (needs documentation)
r
type - (needs documentation)
g
type - (needs documentation)
b
type - (needs documentation)
font
type - (needs documentation)
size
type - (needs documentation)
outline
type - (needs documentation)
sticky
type - (needs documentation)
icon
type - (needs documentation)

Notes

An alias for :SoarMessage() with a location of "OUTGOING"

Example

-- Sends a yellow message in the default font with a thick outline to the outgoing text frame
self:SoarOutgoing("Hello from my addon!")