/trunk
## Interface: 30100 |
## Title: DirtyRecruit |
## Author: Dirtygurl |
## Version: 1.0-a |
## Notes: Automatic guild recruitment spam. |
## SavedVariables: DirtyRecruitGlobal |
## SavedVariablesPerCharacter: DirtyRecruitPerPlayer |
libs\LibStub\LibStub.lua |
libs\LibQTip\LibQTip-1.0.lua |
DirtyRecruit.lua |
GNU GENERAL PUBLIC LICENSE |
Version 3, 29 June 2007 |
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
Everyone is permitted to copy and distribute verbatim copies |
of this license document, but changing it is not allowed. |
Preamble |
The GNU General Public License is a free, copyleft license for |
software and other kinds of works. |
The licenses for most software and other practical works are designed |
to take away your freedom to share and change the works. By contrast, |
the GNU General Public License is intended to guarantee your freedom to |
share and change all versions of a program--to make sure it remains free |
software for all its users. We, the Free Software Foundation, use the |
GNU General Public License for most of our software; it applies also to |
any other work released this way by its authors. You can apply it to |
your programs, too. |
When we speak of free software, we are referring to freedom, not |
price. Our General Public Licenses are designed to make sure that you |
have the freedom to distribute copies of free software (and charge for |
them if you wish), that you receive source code or can get it if you |
want it, that you can change the software or use pieces of it in new |
free programs, and that you know you can do these things. |
To protect your rights, we need to prevent others from denying you |
these rights or asking you to surrender the rights. Therefore, you have |
certain responsibilities if you distribute copies of the software, or if |
you modify it: responsibilities to respect the freedom of others. |
For example, if you distribute copies of such a program, whether |
gratis or for a fee, you must pass on to the recipients the same |
freedoms that you received. You must make sure that they, too, receive |
or can get the source code. And you must show them these terms so they |
know their rights. |
Developers that use the GNU GPL protect your rights with two steps: |
(1) assert copyright on the software, and (2) offer you this License |
giving you legal permission to copy, distribute and/or modify it. |
For the developers' and authors' protection, the GPL clearly explains |
that there is no warranty for this free software. For both users' and |
authors' sake, the GPL requires that modified versions be marked as |
changed, so that their problems will not be attributed erroneously to |
authors of previous versions. |
Some devices are designed to deny users access to install or run |
modified versions of the software inside them, although the manufacturer |
can do so. This is fundamentally incompatible with the aim of |
protecting users' freedom to change the software. The systematic |
pattern of such abuse occurs in the area of products for individuals to |
use, which is precisely where it is most unacceptable. Therefore, we |
have designed this version of the GPL to prohibit the practice for those |
products. If such problems arise substantially in other domains, we |
stand ready to extend this provision to those domains in future versions |
of the GPL, as needed to protect the freedom of users. |
Finally, every program is threatened constantly by software patents. |
States should not allow patents to restrict development and use of |
software on general-purpose computers, but in those that do, we wish to |
avoid the special danger that patents applied to a free program could |
make it effectively proprietary. To prevent this, the GPL assures that |
patents cannot be used to render the program non-free. |
The precise terms and conditions for copying, distribution and |
modification follow. |
TERMS AND CONDITIONS |
0. Definitions. |
"This License" refers to version 3 of the GNU General Public License. |
"Copyright" also means copyright-like laws that apply to other kinds of |
works, such as semiconductor masks. |
"The Program" refers to any copyrightable work licensed under this |
License. Each licensee is addressed as "you". "Licensees" and |
"recipients" may be individuals or organizations. |
To "modify" a work means to copy from or adapt all or part of the work |
in a fashion requiring copyright permission, other than the making of an |
exact copy. The resulting work is called a "modified version" of the |
earlier work or a work "based on" the earlier work. |
A "covered work" means either the unmodified Program or a work based |
on the Program. |
To "propagate" a work means to do anything with it that, without |
permission, would make you directly or secondarily liable for |
infringement under applicable copyright law, except executing it on a |
computer or modifying a private copy. Propagation includes copying, |
distribution (with or without modification), making available to the |
public, and in some countries other activities as well. |
To "convey" a work means any kind of propagation that enables other |
parties to make or receive copies. Mere interaction with a user through |
a computer network, with no transfer of a copy, is not conveying. |
An interactive user interface displays "Appropriate Legal Notices" |
to the extent that it includes a convenient and prominently visible |
feature that (1) displays an appropriate copyright notice, and (2) |
tells the user that there is no warranty for the work (except to the |
extent that warranties are provided), that licensees may convey the |
work under this License, and how to view a copy of this License. If |
the interface presents a list of user commands or options, such as a |
menu, a prominent item in the list meets this criterion. |
1. Source Code. |
The "source code" for a work means the preferred form of the work |
for making modifications to it. "Object code" means any non-source |
form of a work. |
A "Standard Interface" means an interface that either is an official |
standard defined by a recognized standards body, or, in the case of |
interfaces specified for a particular programming language, one that |
is widely used among developers working in that language. |
The "System Libraries" of an executable work include anything, other |
than the work as a whole, that (a) is included in the normal form of |
packaging a Major Component, but which is not part of that Major |
Component, and (b) serves only to enable use of the work with that |
Major Component, or to implement a Standard Interface for which an |
implementation is available to the public in source code form. A |
"Major Component", in this context, means a major essential component |
(kernel, window system, and so on) of the specific operating system |
(if any) on which the executable work runs, or a compiler used to |
produce the work, or an object code interpreter used to run it. |
The "Corresponding Source" for a work in object code form means all |
the source code needed to generate, install, and (for an executable |
work) run the object code and to modify the work, including scripts to |
control those activities. However, it does not include the work's |
System Libraries, or general-purpose tools or generally available free |
programs which are used unmodified in performing those activities but |
which are not part of the work. For example, Corresponding Source |
includes interface definition files associated with source files for |
the work, and the source code for shared libraries and dynamically |
linked subprograms that the work is specifically designed to require, |
such as by intimate data communication or control flow between those |
subprograms and other parts of the work. |
The Corresponding Source need not include anything that users |
can regenerate automatically from other parts of the Corresponding |
Source. |
The Corresponding Source for a work in source code form is that |
same work. |
2. Basic Permissions. |
All rights granted under this License are granted for the term of |
copyright on the Program, and are irrevocable provided the stated |
conditions are met. This License explicitly affirms your unlimited |
permission to run the unmodified Program. The output from running a |
covered work is covered by this License only if the output, given its |
content, constitutes a covered work. This License acknowledges your |
rights of fair use or other equivalent, as provided by copyright law. |
You may make, run and propagate covered works that you do not |
convey, without conditions so long as your license otherwise remains |
in force. You may convey covered works to others for the sole purpose |
of having them make modifications exclusively for you, or provide you |
with facilities for running those works, provided that you comply with |
the terms of this License in conveying all material for which you do |
not control copyright. Those thus making or running the covered works |
for you must do so exclusively on your behalf, under your direction |
and control, on terms that prohibit them from making any copies of |
your copyrighted material outside their relationship with you. |
Conveying under any other circumstances is permitted solely under |
the conditions stated below. Sublicensing is not allowed; section 10 |
makes it unnecessary. |
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
No covered work shall be deemed part of an effective technological |
measure under any applicable law fulfilling obligations under article |
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
similar laws prohibiting or restricting circumvention of such |
measures. |
When you convey a covered work, you waive any legal power to forbid |
circumvention of technological measures to the extent such circumvention |
is effected by exercising rights under this License with respect to |
the covered work, and you disclaim any intention to limit operation or |
modification of the work as a means of enforcing, against the work's |
users, your or third parties' legal rights to forbid circumvention of |
technological measures. |
4. Conveying Verbatim Copies. |
You may convey verbatim copies of the Program's source code as you |
receive it, in any medium, provided that you conspicuously and |
appropriately publish on each copy an appropriate copyright notice; |
keep intact all notices stating that this License and any |
non-permissive terms added in accord with section 7 apply to the code; |
keep intact all notices of the absence of any warranty; and give all |
recipients a copy of this License along with the Program. |
You may charge any price or no price for each copy that you convey, |
and you may offer support or warranty protection for a fee. |
5. Conveying Modified Source Versions. |
You may convey a work based on the Program, or the modifications to |
produce it from the Program, in the form of source code under the |
terms of section 4, provided that you also meet all of these conditions: |
a) The work must carry prominent notices stating that you modified |
it, and giving a relevant date. |
b) The work must carry prominent notices stating that it is |
released under this License and any conditions added under section |
7. This requirement modifies the requirement in section 4 to |
"keep intact all notices". |
c) You must license the entire work, as a whole, under this |
License to anyone who comes into possession of a copy. This |
License will therefore apply, along with any applicable section 7 |
additional terms, to the whole of the work, and all its parts, |
regardless of how they are packaged. This License gives no |
permission to license the work in any other way, but it does not |
invalidate such permission if you have separately received it. |
d) If the work has interactive user interfaces, each must display |
Appropriate Legal Notices; however, if the Program has interactive |
interfaces that do not display Appropriate Legal Notices, your |
work need not make them do so. |
A compilation of a covered work with other separate and independent |
works, which are not by their nature extensions of the covered work, |
and which are not combined with it such as to form a larger program, |
in or on a volume of a storage or distribution medium, is called an |
"aggregate" if the compilation and its resulting copyright are not |
used to limit the access or legal rights of the compilation's users |
beyond what the individual works permit. Inclusion of a covered work |
in an aggregate does not cause this License to apply to the other |
parts of the aggregate. |
6. Conveying Non-Source Forms. |
You may convey a covered work in object code form under the terms |
of sections 4 and 5, provided that you also convey the |
machine-readable Corresponding Source under the terms of this License, |
in one of these ways: |
a) Convey the object code in, or embodied in, a physical product |
(including a physical distribution medium), accompanied by the |
Corresponding Source fixed on a durable physical medium |
customarily used for software interchange. |
b) Convey the object code in, or embodied in, a physical product |
(including a physical distribution medium), accompanied by a |
written offer, valid for at least three years and valid for as |
long as you offer spare parts or customer support for that product |
model, to give anyone who possesses the object code either (1) a |
copy of the Corresponding Source for all the software in the |
product that is covered by this License, on a durable physical |
medium customarily used for software interchange, for a price no |
more than your reasonable cost of physically performing this |
conveying of source, or (2) access to copy the |
Corresponding Source from a network server at no charge. |
c) Convey individual copies of the object code with a copy of the |
written offer to provide the Corresponding Source. This |
alternative is allowed only occasionally and noncommercially, and |
only if you received the object code with such an offer, in accord |
with subsection 6b. |
d) Convey the object code by offering access from a designated |
place (gratis or for a charge), and offer equivalent access to the |
Corresponding Source in the same way through the same place at no |
further charge. You need not require recipients to copy the |
Corresponding Source along with the object code. If the place to |
copy the object code is a network server, the Corresponding Source |
may be on a different server (operated by you or a third party) |
that supports equivalent copying facilities, provided you maintain |
clear directions next to the object code saying where to find the |
Corresponding Source. Regardless of what server hosts the |
Corresponding Source, you remain obligated to ensure that it is |
available for as long as needed to satisfy these requirements. |
e) Convey the object code using peer-to-peer transmission, provided |
you inform other peers where the object code and Corresponding |
Source of the work are being offered to the general public at no |
charge under subsection 6d. |
A separable portion of the object code, whose source code is excluded |
from the Corresponding Source as a System Library, need not be |
included in conveying the object code work. |
A "User Product" is either (1) a "consumer product", which means any |
tangible personal property which is normally used for personal, family, |
or household purposes, or (2) anything designed or sold for incorporation |
into a dwelling. In determining whether a product is a consumer product, |
doubtful cases shall be resolved in favor of coverage. For a particular |
product received by a particular user, "normally used" refers to a |
typical or common use of that class of product, regardless of the status |
of the particular user or of the way in which the particular user |
actually uses, or expects or is expected to use, the product. A product |
is a consumer product regardless of whether the product has substantial |
commercial, industrial or non-consumer uses, unless such uses represent |
the only significant mode of use of the product. |
"Installation Information" for a User Product means any methods, |
procedures, authorization keys, or other information required to install |
and execute modified versions of a covered work in that User Product from |
a modified version of its Corresponding Source. The information must |
suffice to ensure that the continued functioning of the modified object |
code is in no case prevented or interfered with solely because |
modification has been made. |
If you convey an object code work under this section in, or with, or |
specifically for use in, a User Product, and the conveying occurs as |
part of a transaction in which the right of possession and use of the |
User Product is transferred to the recipient in perpetuity or for a |
fixed term (regardless of how the transaction is characterized), the |
Corresponding Source conveyed under this section must be accompanied |
by the Installation Information. But this requirement does not apply |
if neither you nor any third party retains the ability to install |
modified object code on the User Product (for example, the work has |
been installed in ROM). |
The requirement to provide Installation Information does not include a |
requirement to continue to provide support service, warranty, or updates |
for a work that has been modified or installed by the recipient, or for |
the User Product in which it has been modified or installed. Access to a |
network may be denied when the modification itself materially and |
adversely affects the operation of the network or violates the rules and |
protocols for communication across the network. |
Corresponding Source conveyed, and Installation Information provided, |
in accord with this section must be in a format that is publicly |
documented (and with an implementation available to the public in |
source code form), and must require no special password or key for |
unpacking, reading or copying. |
7. Additional Terms. |
"Additional permissions" are terms that supplement the terms of this |
License by making exceptions from one or more of its conditions. |
Additional permissions that are applicable to the entire Program shall |
be treated as though they were included in this License, to the extent |
that they are valid under applicable law. If additional permissions |
apply only to part of the Program, that part may be used separately |
under those permissions, but the entire Program remains governed by |
this License without regard to the additional permissions. |
When you convey a copy of a covered work, you may at your option |
remove any additional permissions from that copy, or from any part of |
it. (Additional permissions may be written to require their own |
removal in certain cases when you modify the work.) You may place |
additional permissions on material, added by you to a covered work, |
for which you have or can give appropriate copyright permission. |
Notwithstanding any other provision of this License, for material you |
add to a covered work, you may (if authorized by the copyright holders of |
that material) supplement the terms of this License with terms: |
a) Disclaiming warranty or limiting liability differently from the |
terms of sections 15 and 16 of this License; or |
b) Requiring preservation of specified reasonable legal notices or |
author attributions in that material or in the Appropriate Legal |
Notices displayed by works containing it; or |
c) Prohibiting misrepresentation of the origin of that material, or |
requiring that modified versions of such material be marked in |
reasonable ways as different from the original version; or |
d) Limiting the use for publicity purposes of names of licensors or |
authors of the material; or |
e) Declining to grant rights under trademark law for use of some |
trade names, trademarks, or service marks; or |
f) Requiring indemnification of licensors and authors of that |
material by anyone who conveys the material (or modified versions of |
it) with contractual assumptions of liability to the recipient, for |
any liability that these contractual assumptions directly impose on |
those licensors and authors. |
All other non-permissive additional terms are considered "further |
restrictions" within the meaning of section 10. If the Program as you |
received it, or any part of it, contains a notice stating that it is |
governed by this License along with a term that is a further |
restriction, you may remove that term. If a license document contains |
a further restriction but permits relicensing or conveying under this |
License, you may add to a covered work material governed by the terms |
of that license document, provided that the further restriction does |
not survive such relicensing or conveying. |
If you add terms to a covered work in accord with this section, you |
must place, in the relevant source files, a statement of the |
additional terms that apply to those files, or a notice indicating |
where to find the applicable terms. |
Additional terms, permissive or non-permissive, may be stated in the |
form of a separately written license, or stated as exceptions; |
the above requirements apply either way. |
8. Termination. |
You may not propagate or modify a covered work except as expressly |
provided under this License. Any attempt otherwise to propagate or |
modify it is void, and will automatically terminate your rights under |
this License (including any patent licenses granted under the third |
paragraph of section 11). |
However, if you cease all violation of this License, then your |
license from a particular copyright holder is reinstated (a) |
provisionally, unless and until the copyright holder explicitly and |
finally terminates your license, and (b) permanently, if the copyright |
holder fails to notify you of the violation by some reasonable means |
prior to 60 days after the cessation. |
Moreover, your license from a particular copyright holder is |
reinstated permanently if the copyright holder notifies you of the |
violation by some reasonable means, this is the first time you have |
received notice of violation of this License (for any work) from that |
copyright holder, and you cure the violation prior to 30 days after |
your receipt of the notice. |
Termination of your rights under this section does not terminate the |
licenses of parties who have received copies or rights from you under |
this License. If your rights have been terminated and not permanently |
reinstated, you do not qualify to receive new licenses for the same |
material under section 10. |
9. Acceptance Not Required for Having Copies. |
You are not required to accept this License in order to receive or |
run a copy of the Program. Ancillary propagation of a covered work |
occurring solely as a consequence of using peer-to-peer transmission |
to receive a copy likewise does not require acceptance. However, |
nothing other than this License grants you permission to propagate or |
modify any covered work. These actions infringe copyright if you do |
not accept this License. Therefore, by modifying or propagating a |
covered work, you indicate your acceptance of this License to do so. |
10. Automatic Licensing of Downstream Recipients. |
Each time you convey a covered work, the recipient automatically |
receives a license from the original licensors, to run, modify and |
propagate that work, subject to this License. You are not responsible |
for enforcing compliance by third parties with this License. |
An "entity transaction" is a transaction transferring control of an |
organization, or substantially all assets of one, or subdividing an |
organization, or merging organizations. If propagation of a covered |
work results from an entity transaction, each party to that |
transaction who receives a copy of the work also receives whatever |
licenses to the work the party's predecessor in interest had or could |
give under the previous paragraph, plus a right to possession of the |
Corresponding Source of the work from the predecessor in interest, if |
the predecessor has it or can get it with reasonable efforts. |
You may not impose any further restrictions on the exercise of the |
rights granted or affirmed under this License. For example, you may |
not impose a license fee, royalty, or other charge for exercise of |
rights granted under this License, and you may not initiate litigation |
(including a cross-claim or counterclaim in a lawsuit) alleging that |
any patent claim is infringed by making, using, selling, offering for |
sale, or importing the Program or any portion of it. |
11. Patents. |
A "contributor" is a copyright holder who authorizes use under this |
License of the Program or a work on which the Program is based. The |
work thus licensed is called the contributor's "contributor version". |
A contributor's "essential patent claims" are all patent claims |
owned or controlled by the contributor, whether already acquired or |
hereafter acquired, that would be infringed by some manner, permitted |
by this License, of making, using, or selling its contributor version, |
but do not include claims that would be infringed only as a |
consequence of further modification of the contributor version. For |
purposes of this definition, "control" includes the right to grant |
patent sublicenses in a manner consistent with the requirements of |
this License. |
Each contributor grants you a non-exclusive, worldwide, royalty-free |
patent license under the contributor's essential patent claims, to |
make, use, sell, offer for sale, import and otherwise run, modify and |
propagate the contents of its contributor version. |
In the following three paragraphs, a "patent license" is any express |
agreement or commitment, however denominated, not to enforce a patent |
(such as an express permission to practice a patent or covenant not to |
sue for patent infringement). To "grant" such a patent license to a |
party means to make such an agreement or commitment not to enforce a |
patent against the party. |
If you convey a covered work, knowingly relying on a patent license, |
and the Corresponding Source of the work is not available for anyone |
to copy, free of charge and under the terms of this License, through a |
publicly available network server or other readily accessible means, |
then you must either (1) cause the Corresponding Source to be so |
available, or (2) arrange to deprive yourself of the benefit of the |
patent license for this particular work, or (3) arrange, in a manner |
consistent with the requirements of this License, to extend the patent |
license to downstream recipients. "Knowingly relying" means you have |
actual knowledge that, but for the patent license, your conveying the |
covered work in a country, or your recipient's use of the covered work |
in a country, would infringe one or more identifiable patents in that |
country that you have reason to believe are valid. |
If, pursuant to or in connection with a single transaction or |
arrangement, you convey, or propagate by procuring conveyance of, a |
covered work, and grant a patent license to some of the parties |
receiving the covered work authorizing them to use, propagate, modify |
or convey a specific copy of the covered work, then the patent license |
you grant is automatically extended to all recipients of the covered |
work and works based on it. |
A patent license is "discriminatory" if it does not include within |
the scope of its coverage, prohibits the exercise of, or is |
conditioned on the non-exercise of one or more of the rights that are |
specifically granted under this License. You may not convey a covered |
work if you are a party to an arrangement with a third party that is |
in the business of distributing software, under which you make payment |
to the third party based on the extent of your activity of conveying |
the work, and under which the third party grants, to any of the |
parties who would receive the covered work from you, a discriminatory |
patent license (a) in connection with copies of the covered work |
conveyed by you (or copies made from those copies), or (b) primarily |
for and in connection with specific products or compilations that |
contain the covered work, unless you entered into that arrangement, |
or that patent license was granted, prior to 28 March 2007. |
Nothing in this License shall be construed as excluding or limiting |
any implied license or other defenses to infringement that may |
otherwise be available to you under applicable patent law. |
12. No Surrender of Others' Freedom. |
If conditions are imposed on you (whether by court order, agreement or |
otherwise) that contradict the conditions of this License, they do not |
excuse you from the conditions of this License. If you cannot convey a |
covered work so as to satisfy simultaneously your obligations under this |
License and any other pertinent obligations, then as a consequence you may |
not convey it at all. For example, if you agree to terms that obligate you |
to collect a royalty for further conveying from those to whom you convey |
the Program, the only way you could satisfy both those terms and this |
License would be to refrain entirely from conveying the Program. |
13. Use with the GNU Affero General Public License. |
Notwithstanding any other provision of this License, you have |
permission to link or combine any covered work with a work licensed |
under version 3 of the GNU Affero General Public License into a single |
combined work, and to convey the resulting work. The terms of this |
License will continue to apply to the part which is the covered work, |
but the special requirements of the GNU Affero General Public License, |
section 13, concerning interaction through a network will apply to the |
combination as such. |
14. Revised Versions of this License. |
The Free Software Foundation may publish revised and/or new versions of |
the GNU General Public License from time to time. Such new versions will |
be similar in spirit to the present version, but may differ in detail to |
address new problems or concerns. |
Each version is given a distinguishing version number. If the |
Program specifies that a certain numbered version of the GNU General |
Public License "or any later version" applies to it, you have the |
option of following the terms and conditions either of that numbered |
version or of any later version published by the Free Software |
Foundation. If the Program does not specify a version number of the |
GNU General Public License, you may choose any version ever published |
by the Free Software Foundation. |
If the Program specifies that a proxy can decide which future |
versions of the GNU General Public License can be used, that proxy's |
public statement of acceptance of a version permanently authorizes you |
to choose that version for the Program. |
Later license versions may give you additional or different |
permissions. However, no additional obligations are imposed on any |
author or copyright holder as a result of your choosing to follow a |
later version. |
15. Disclaimer of Warranty. |
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
16. Limitation of Liability. |
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
SUCH DAMAGES. |
17. Interpretation of Sections 15 and 16. |
If the disclaimer of warranty and limitation of liability provided |
above cannot be given local legal effect according to their terms, |
reviewing courts shall apply local law that most closely approximates |
an absolute waiver of all civil liability in connection with the |
Program, unless a warranty or assumption of liability accompanies a |
copy of the Program in return for a fee. |
END OF TERMS AND CONDITIONS |
-- DirtyRecruit |
-- Author: Dirtygurl |
-- License: GNU GPL v3, 29 June 2007 (see LICENSE.txt) |
local DirtyRecruit = {} |
DirtyRecruit.Version = GetAddOnMetadata("DirtyRecruit", "Version") |
DirtyRecruit.LibQTip = LibStub("LibQTip-1.0") |
DirtyRecruit.PerPlayer = |
{ |
Active = nil, |
InCombat = nil, |
UpdateInterval = 300.0, -- 5 minutes |
Ad = "--MyGuild-- is recruiting any level players for groups and end game content. We have a Guild Tabard, Vent, and Website PST if you want to join some of the best players in the game." |
} |
DirtyRecruit.Spammed = nil |
DirtyRecruit.TimeSinceLastUpdate = 0 |
function DirtyRecruit.Print(msg) |
if DEFAULT_CHAT_FRAME then |
DEFAULT_CHAT_FRAME:AddMessage("|cFF00FF00[DirtyRecruit]|r "..msg, 1, 1, 1) |
end |
end |
function DirtyRecruit.IsInPVPOrInstance() |
local instance = IsInInstance() |
local zone = GetZoneText() |
if instance ~= nil or zone == "Wintergrasp" then |
return 1 |
end |
return nil |
end |
function DirtyRecruit.Advertise() |
local gName = GetGuildInfo("player") |
local adPrint = 1 |
if adPrint then |
local iIndex = nil |
local _, nGeneral = GetChannelName(1) |
local _, nTrade = GetChannelName(2) |
if nTrade and nTrade:match("^Trade - ") then |
iIndex = 2 |
elseif nGeneral and nGeneral:match("^General - ") then |
iIndex = 1 |
end |
if iIndex ~= nil then |
--DirtyRecruit.Print(iIndex..": "..DirtyRecruit.PerPlayer.Ad) |
SendChatMessage(DirtyRecruit.PerPlayer.Ad, "CHANNEL", nil, iIndex) |
SendAddonMessage("DirtyRecruit", "guildAdvertised:"..GetZoneText(), "GUILD") |
end |
end |
end |
function DirtyRecruit.OnUpdateSpam(self, elapsed) |
--DirtyRecruit.Print("OnUpdate") |
DirtyRecruit.TimeSinceLastUpdate = DirtyRecruit.TimeSinceLastUpdate + elapsed |
if DirtyRecruit.TimeSinceLastUpdate > DirtyRecruit.PerPlayer.UpdateInterval then |
if IsInGuild() and CanGuildInvite() and DirtyRecruit.PerPlayer.Ad ~= nil and DirtyRecruit.PerPlayer.Active and not DirtyRecruit.PerPlayer.InCombat and not DirtyRecruit.IsInPVPOrInstance() then |
DirtyRecruit.Advertise() |
end |
DirtyRecruit.TimeSinceLastUpdate = 0 |
end |
end |
function DirtyRecruit.OnPlayerRegenDisabled() |
--DirtyRecruit.Print("OnEvent:PLAYER_REGEN_DISABLED") |
DirtyRecruit.PerPlayer.InCombat = 1 |
end |
function DirtyRecruit.OnPlayerRegenEnabled() |
--DirtyRecruit.Print("OnEvent:PLAYER_REGEN_ENABLED") |
DirtyRecruit.PerPlayer.InCombat = nil |
end |
function DirtyRecruit.OnChatMsgAddOn(action) |
--DirtyRecruit.Print("OnEvent:CHAT_MSG_ADDON") |
local a, b = strsplit(":", action) |
if a == "guildAdvertised" and b == GetZoneText() then |
DirtyRecruit.TimeSinceLastUpdate = 0 |
end |
end |
function DirtyRecruit.OnVariablesLoaded() |
--DirtyRecruit.Print("OnEvent:VARIABLES_LOADED") |
--[[ |
-- Global Variables |
--]] |
if not DirtyRecruitGlobal then |
DirtyRecruitGlobal = DirtyRecruit.Global |
end |
if not DirtyRecruitPerPlayer then |
DirtyRecruitPerPlayer = DirtyRecruit.PerPlayer |
end |
DirtyRecruit.Global = DirtyRecruitGlobal |
DirtyRecruit.PerPlayer = DirtyRecruitPerPlayer |
end |
function DirtyRecruit.OnAddOnLoaded() |
--DirtyRecruit.Print("OnEvent:ADDON_LOADED") |
SlashCmdList["DIRTYRECRUIT"] = DirtyRecruit.SlashHandler |
SLASH_DIRTYRECRUIT1 = "/dirtyrecruit" |
DirtyRecruit.Print("DirtyRecruit Loaded. Type /dirtyrecruit for more information.") |
end |
function DirtyRecruit.OnEvent() |
if event == "PLAYER_REGEN_DISABLED" then |
DirtyRecruit.OnPlayerRegenDisabled() |
elseif event == "PLAYER_REGEN_ENABLED" then |
DirtyRecruit.OnPlayerRegenEnabled() |
elseif event == "CHAT_MSG_ADDON" and arg1 == "DirtyRecruit" then |
DirtyRecruit.OnChatMsgAddOn(arg2) |
elseif event == "VARIABLES_LOADED" then |
DirtyRecruit.OnVariablesLoaded() |
elseif event == "ADDON_LOADED" and arg1 == "DirtyRecruit" then |
DirtyRecruit.OnAddOnLoaded() |
end |
end |
function DirtyRecruit.UpdateSettings() |
DirtyRecruitGlobal = DirtyRecruit.Global |
DirtyRecruitPerPlayer = DirtyRecruit.PerPlayer |
end |
function DirtyRecruit.SlashHandler(cmd) |
local cmdTmp, arg = cmd:match("^(%S*)%s*(.-)$") |
if arg then |
cmd = strlower(cmdTmp) |
else |
cmd = strlower(cmd) |
end |
if cmd == "version" or cmd == "v" then |
DirtyRecruit.Print("Name: DirtyRecruit, Version: "..DirtyRecruit.Version) |
elseif cmd == "help" then |
DirtyRecruit.Print("Type |cffffff7f/dirtyrecruit set <advertisement>|r and set your advertising message.") |
elseif cmd == "disable" then |
DirtyRecruit.Print("disabled") |
DirtyRecruit.PerPlayer.Active = nil |
DirtyRecruit.UpdateSettings() |
elseif cmd == "enable" then |
DirtyRecruit.Print("enabled") |
DirtyRecruit.PerPlayer.Active = 1 |
DirtyRecruit.UpdateSettings() |
elseif cmd == "set" and arg then |
DirtyRecruit.Print("Ad: "..arg) |
DirtyRecruit.PerPlayer.Ad = arg |
DirtyRecruit.UpdateSettings() |
elseif cmd == "unset" then |
DirtyRecruit.Print("unset") |
DirtyRecruit.PerPlayer.Ad = nil |
DirtyRecruit.UpdateSettings() |
elseif cmd == "interval" and arg then |
if tonumber(arg) >= 10 then |
DirtyRecruit.Print("interval set to "..tonumber(arg)) |
DirtyRecruit.PerPlayer.UpdateInterval = tonumber(arg) |
DirtyRecruit.UpdateSettings() |
else |
DirtyRecruit.Print("interval could not be set") |
end |
elseif cmd == "test" then |
if DirtyRecruit.PerPlayer.Ad then |
DirtyRecruit.Print(DirtyRecruit.PerPlayer.Ad) |
else |
DirtyRecruit.Print("no advertisement was found") |
end |
else |
DirtyRecruit.Print("DirtyRecruit v"..DirtyRecruit.Version) |
DirtyRecruit.Print("Syntax: |cffffff7f/dirtyrecruit <command> <args>|r") |
DirtyRecruit.Print(" |cff00ff00v|version|r - Shows addon version.") |
DirtyRecruit.Print(" |cff00ff00enable|disable|r - Enables/Disables addon.") |
DirtyRecruit.Print(" |cff00ff00set|unset|r - Set/Unset addon advertisement message.") |
DirtyRecruit.Print(" |cff00ff00interval|r - Sets the interval (in seconds) for advertising.") |
DirtyRecruit.Print(" |cff00ff00test|r - Prints out a test advertisement for private viewing.") |
DirtyRecruit.Print(" |cff00ff00help|r - Shows addon help.") |
end |
end |
DirtyRecruit.FrameSpam = CreateFrame("Frame") |
DirtyRecruit.FrameSpam:SetScript("OnUpdate", DirtyRecruit.OnUpdateSpam) |
DirtyRecruit.Frame = DirtyRecruit.LibQTip:Acquire("DirtyRecruitFrame") |
DirtyRecruit.Frame:RegisterEvent("PLAYER_REGEN_DISABLED") |
DirtyRecruit.Frame:RegisterEvent("PLAYER_REGEN_ENABLED") |
DirtyRecruit.Frame:RegisterEvent("CHAT_MSG_ADDON") |
DirtyRecruit.Frame:RegisterEvent("VARIABLES_LOADED") |
DirtyRecruit.Frame:RegisterEvent("ADDON_LOADED") |
DirtyRecruit.Frame:SetScript("OnEvent", DirtyRecruit.OnEvent) |
local MAJOR = "LibQTip-1.0" |
local MINOR = 22 -- Should be manually increased |
assert(LibStub, MAJOR.." requires LibStub") |
local lib, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not lib then return end -- No upgrade needed |
------------------------------------------------------------------------------ |
-- Upvalued globals |
------------------------------------------------------------------------------ |
local type = type |
local select = select |
local error = error |
local pairs, ipairs = pairs, ipairs |
local tonumber, tostring = tonumber, tostring |
local strfind = string.find |
local math = math |
local min, max = math.min, math.max |
local setmetatable = setmetatable |
local tinsert, tremove = tinsert, tremove |
local wipe = wipe |
local CreateFrame = CreateFrame |
local UIParent = UIParent |
local MouseIsOver = MouseIsOver |
------------------------------------------------------------------------------ |
-- Tables and locals |
------------------------------------------------------------------------------ |
lib.frameMetatable = lib.frameMetatable or {__index = CreateFrame("Frame")} |
lib.tipPrototype = lib.tipPrototype or setmetatable({}, lib.frameMetatable) |
lib.tipMetatable = lib.tipMetatable or {__index = lib.tipPrototype} |
lib.providerPrototype = lib.providerPrototype or {} |
lib.providerMetatable = lib.providerMetatable or {__index = lib.providerPrototype} |
lib.cellPrototype = lib.cellPrototype or setmetatable({}, lib.frameMetatable) |
lib.cellMetatable = lib.cellMetatable or { __index = lib.cellPrototype } |
lib.activeTooltips = lib.activeTooltips or {} |
lib.tooltipHeap = lib.tooltipHeap or {} |
lib.frameHeap = lib.frameHeap or {} |
lib.tableHeap = lib.tableHeap or {} |
local tipPrototype = lib.tipPrototype |
local tipMetatable = lib.tipMetatable |
local providerPrototype = lib.providerPrototype |
local providerMetatable = lib.providerMetatable |
local cellPrototype = lib.cellPrototype |
local cellMetatable = lib.cellMetatable |
local activeTooltips = lib.activeTooltips |
------------------------------------------------------------------------------ |
-- Private methods for Caches and Tooltip |
------------------------------------------------------------------------------ |
local AcquireTooltip, ReleaseTooltip |
local AcquireCell, ReleaseCell |
local AcquireTable, ReleaseTable |
local InitializeTooltip, SetTooltipSize, ResetTooltipSize, LayoutColspans |
------------------------------------------------------------------------------ |
-- Cache debugging. |
------------------------------------------------------------------------------ |
--[===[@debug@ |
local usedTables, usedFrames, usedTooltips = 0, 0, 0 |
--@end-debug@]===] |
------------------------------------------------------------------------------ |
-- Internal constants to tweak the layout |
------------------------------------------------------------------------------ |
local TOOLTIP_PADDING = 10 |
local CELL_MARGIN_H = 6 |
local CELL_MARGIN_V = 3 |
------------------------------------------------------------------------------ |
-- Public library API |
------------------------------------------------------------------------------ |
--- Create or retrieve the tooltip with the given key. |
-- If additional arguments are passed, they are passed to :SetColumnLayout for the acquired tooltip. |
-- @name LibQTip:Acquire(key[, numColumns, column1Justification, column2justification, ...]) |
-- @param key string or table - the tooltip key. Any value that can be used as a table key is accepted though you should try to provide unique keys to avoid conflicts. |
-- Numbers and booleans should be avoided and strings should be carefully chosen to avoid namespace clashes - no "MyTooltip" - you have been warned! |
-- @return tooltip Frame object - the acquired tooltip. |
-- @usage Acquire a tooltip with at least 5 columns, justification : left, center, left, left, left |
-- <pre>local tip = LibStub('LibQTip-1.0'):Acquire('MyFooBarTooltip', 5, "LEFT", "CENTER")</pre> |
function lib:Acquire(key, ...) |
if key == nil then error("attempt to use a nil key", 2) end |
local tooltip = activeTooltips[key] |
if not tooltip then |
tooltip = AcquireTooltip() |
InitializeTooltip(tooltip, key) |
activeTooltips[key] = tooltip |
end |
if select('#', ...) > 0 then |
-- Here we catch any error to properly report it for the calling code |
local ok, msg = pcall(tooltip.SetColumnLayout, tooltip, ...) |
if not ok then error(msg, 2) end |
end |
return tooltip |
end |
function lib:Release(tooltip) |
local key = tooltip and tooltip.key |
if not key or activeTooltips[key] ~= tooltip then return end |
ReleaseTooltip(tooltip) |
activeTooltips[key] = nil |
end |
function lib:IsAcquired(key) |
if key == nil then error("attempt to use a nil key", 2) end |
return not not activeTooltips[key] |
end |
function lib:IterateTooltips() |
return pairs(activeTooltips) |
end |
------------------------------------------------------------------------------ |
-- Frame cache |
------------------------------------------------------------------------------ |
local frameHeap = lib.frameHeap |
local function AcquireFrame(parent) |
local frame = tremove(frameHeap) or CreateFrame("Frame") |
frame:SetParent(parent) |
--[===[@debug@ |
usedFrames = usedFrames + 1 |
--@end-debug@]===] |
return frame |
end |
local function ReleaseFrame(frame) |
frame:Hide() |
frame:SetParent(nil) |
frame:ClearAllPoints() |
frame:SetBackdrop(nil) |
tinsert(frameHeap, frame) |
--[===[@debug@ |
usedFrames = usedFrames - 1 |
--@end-debug@]===] |
end |
------------------------------------------------------------------------------ |
-- Dirty layout handler |
------------------------------------------------------------------------------ |
lib.layoutCleaner = lib.layoutCleaner or CreateFrame('Frame') |
local layoutCleaner = lib.layoutCleaner |
layoutCleaner.registry = layoutCleaner.registry or {} |
function layoutCleaner:RegisterForCleanup(tooltip) |
self.registry[tooltip] = true |
self:Show() |
end |
function layoutCleaner:CleanupLayouts() |
self:Hide() |
for tooltip in pairs(self.registry) do |
LayoutColspans(tooltip) |
end |
wipe(self.registry) |
end |
layoutCleaner:SetScript('OnUpdate', layoutCleaner.CleanupLayouts) |
------------------------------------------------------------------------------ |
-- CellProvider and Cell |
------------------------------------------------------------------------------ |
function providerPrototype:AcquireCell() |
local cell = tremove(self.heap) |
if not cell then |
cell = setmetatable(CreateFrame("Frame", nil, UIParent), self.cellMetatable) |
if type(cell.InitializeCell) == 'function' then |
cell:InitializeCell() |
end |
end |
self.cells[cell] = true |
return cell |
end |
function providerPrototype:ReleaseCell(cell) |
if not self.cells[cell] then return end |
if type(cell.ReleaseCell) == 'function' then |
cell:ReleaseCell() |
end |
self.cells[cell] = nil |
tinsert(self.heap, cell) |
end |
function providerPrototype:GetCellPrototype() |
return self.cellPrototype, self.cellMetatable |
end |
function providerPrototype:IterateCells() |
return pairs(self.cells) |
end |
function lib:CreateCellProvider(baseProvider) |
local cellBaseMetatable, cellBasePrototype |
if baseProvider and baseProvider.GetCellPrototype then |
cellBasePrototype, cellBaseMetatable = baseProvider:GetCellPrototype() |
else |
cellBaseMetatable = cellMetatable |
end |
local cellPrototype = setmetatable({}, cellBaseMetatable) |
local cellProvider = setmetatable({}, providerMetatable) |
cellProvider.heap = {} |
cellProvider.cells = {} |
cellProvider.cellPrototype = cellPrototype |
cellProvider.cellMetatable = { __index = cellPrototype } |
return cellProvider, cellPrototype, cellBasePrototype |
end |
------------------------------------------------------------------------------ |
-- Basic label provider |
------------------------------------------------------------------------------ |
if not lib.LabelProvider then |
lib.LabelProvider, lib.LabelPrototype = lib:CreateCellProvider() |
end |
local labelProvider = lib.LabelProvider |
local labelPrototype = lib.LabelPrototype |
function labelPrototype:InitializeCell() |
self.fontString = self:CreateFontString() |
self.fontString:SetFontObject(GameTooltipText) |
end |
function labelPrototype:SetupCell(tooltip, value, justification, font, ...) |
local fs = self.fontString |
fs:SetFontObject(font or tooltip:GetFont()) |
fs:SetJustifyH(justification) |
fs:SetText(tostring(value)) |
-- Variable argument checking |
local l_pad, r_pad, max_width, min_width |
local i, arg = 1, ... |
if arg == nil or type(arg) == "number" then |
i, l_pad, arg = i + 1, select(i, ...) |
end |
l_pad = l_pad or 0 |
if arg == nil or type(arg) == "number" then |
i, r_pad, arg = i + 1, select(i, ...) |
end |
r_pad = r_pad or 0 |
if arg == nil or type(arg) == "number" then |
i, max_width, arg = i + 1, select(i, ...) |
end |
if arg == nil or type(arg) == "number" then |
i, min_width = (i + 1), arg |
end |
-- Use GetHeight() instead of GetStringHeight() so lines which are longer than width will wrap. |
local height = fs:GetHeight() |
local width = fs:GetStringWidth() + l_pad + r_pad |
fs:SetPoint("TOPLEFT", self, "TOPLEFT", l_pad, 0) |
fs:SetPoint("BOTTOMRIGHT", self, "BOTTOMRIGHT", -r_pad, 0) |
if max_width and min_width and (max_width < min_width) then |
error("maximum width cannot be lower than minimum width: "..tostring(max_width).." < "..tostring(min_width), 2) |
end |
if min_width and width < min_width then width = min_width end |
if max_width and (max_width < width) then |
width = max_width |
fs:SetWidth(width) |
height = fs:GetHeight() |
end |
fs:Show() |
return width, height |
end |
function labelPrototype:GetPosition() return self._line, self._column end |
------------------------------------------------------------------------------ |
-- Tooltip cache |
------------------------------------------------------------------------------ |
local tooltipHeap = lib.tooltipHeap |
-- Returns a tooltip |
function AcquireTooltip() |
local tooltip = tremove(tooltipHeap) |
if not tooltip then |
tooltip = CreateFrame("Frame", nil, UIParent) |
local scrollFrame = CreateFrame("ScrollFrame", nil, tooltip) |
scrollFrame:SetPoint("TOP", tooltip, "TOP", 0, -TOOLTIP_PADDING) |
scrollFrame:SetPoint("BOTTOM", tooltip, "BOTTOM", 0, TOOLTIP_PADDING) |
scrollFrame:SetPoint("LEFT", tooltip, "LEFT", TOOLTIP_PADDING, 0) |
scrollFrame:SetPoint("RIGHT", tooltip, "RIGHT", -TOOLTIP_PADDING, 0) |
tooltip.scrollFrame = scrollFrame |
local scrollChild = CreateFrame("Frame", nil, tooltip.scrollframe) |
scrollFrame:SetScrollChild(scrollChild) |
tooltip.scrollChild = scrollChild |
setmetatable(tooltip, tipMetatable) |
end |
--[===[@debug@ |
usedTooltips = usedTooltips + 1 |
--@end-debug@]===] |
return tooltip |
end |
-- Cleans the tooltip and stores it in the cache |
function ReleaseTooltip(tooltip) |
tooltip:SetAutoHideDelay(nil) |
tooltip:Hide() |
tooltip:ClearAllPoints() |
tooltip:Clear() |
if tooltip.slider then |
tooltip.slider:SetValue(0) |
tooltip.slider:Hide() |
tooltip.scrollFrame:SetPoint("RIGHT", tooltip, "RIGHT", -TOOLTIP_PADDING, 0) |
tooltip:EnableMouseWheel(false) |
tooltip:SetScript("OnMouseWheel", nil) |
end |
for i, column in ipairs(tooltip.columns) do |
tooltip.columns[i] = ReleaseFrame(column) |
end |
tooltip.columns = ReleaseTable(tooltip.columns) |
tooltip.lines = ReleaseTable(tooltip.lines) |
tooltip.colspans = ReleaseTable(tooltip.colspans) |
layoutCleaner.registry[tooltip] = nil |
tinsert(tooltipHeap, tooltip) |
--[===[@debug@ |
usedTooltips = usedTooltips - 1 |
--@end-debug@]===] |
end |
------------------------------------------------------------------------------ |
-- Cell 'cache' (just a wrapper to the provider's cache) |
------------------------------------------------------------------------------ |
-- Returns a cell for the given tooltip from the given provider |
function AcquireCell(tooltip, provider) |
local cell = provider:AcquireCell(tooltip) |
cell:SetParent(tooltip.scrollChild) |
cell:SetFrameLevel(tooltip.scrollChild:GetFrameLevel() + 1) |
cell._provider = provider |
return cell |
end |
-- Cleans the cell hands it to its provider for storing |
function ReleaseCell(cell) |
cell:Hide() |
cell:ClearAllPoints() |
cell:SetParent(nil) |
cell._font, cell._justification, cell._colSpan, cell._line, cell._column = nil |
cell._provider:ReleaseCell(cell) |
cell._provider = nil |
end |
------------------------------------------------------------------------------ |
-- Table cache |
------------------------------------------------------------------------------ |
local tableHeap = lib.tableHeap |
-- Returns a table |
function AcquireTable() |
local tbl = tremove(tableHeap) or {} |
--[===[@debug@ |
usedTables = usedTables + 1 |
--@end-debug@]===] |
return tbl |
end |
-- Cleans the table and stores it in the cache |
function ReleaseTable(table) |
wipe(table) |
tinsert(tableHeap, table) |
--[===[@debug@ |
usedTables = usedTables - 1 |
--@end-debug@]===] |
end |
------------------------------------------------------------------------------ |
-- Tooltip prototype |
------------------------------------------------------------------------------ |
function InitializeTooltip(tooltip, key) |
---------------------------------------------------------------------- |
-- (Re)set frame settings |
---------------------------------------------------------------------- |
tooltip:SetBackdrop(GameTooltip:GetBackdrop()) |
tooltip:SetBackdropColor(GameTooltip:GetBackdropColor()) |
tooltip:SetBackdropBorderColor(GameTooltip:GetBackdropBorderColor()) |
tooltip:SetScale(GameTooltip:GetScale()) |
tooltip:SetAlpha(GameTooltip:GetAlpha()) |
tooltip:SetFrameStrata("TOOLTIP") |
tooltip:SetClampedToScreen(false) |
---------------------------------------------------------------------- |
-- Internal data. Since it's possible to Acquire twice without calling |
-- release, check for pre-existence. |
---------------------------------------------------------------------- |
tooltip.key = key |
tooltip.columns = tooltip.columns or AcquireTable() |
tooltip.lines = tooltip.lines or AcquireTable() |
tooltip.colspans = tooltip.colspans or AcquireTable() |
tooltip.regularFont = GameTooltipText |
tooltip.headerFont = GameTooltipHeaderText |
tooltip.labelProvider = labelProvider |
---------------------------------------------------------------------- |
-- Finishing procedures |
---------------------------------------------------------------------- |
tooltip:SetAutoHideDelay(nil) |
tooltip:Hide() |
ResetTooltipSize(tooltip) |
end |
function tipPrototype:SetDefaultProvider(myProvider) |
if not myProvider then return end |
self.labelProvider = myProvider |
end |
function tipPrototype:GetDefaultProvider() return self.labelProvider end |
local function checkJustification(justification, level, silent) |
if justification ~= "LEFT" and justification ~= "CENTER" and justification ~= "RIGHT" then |
if silent then return false end |
error("invalid justification, must one of LEFT, CENTER or RIGHT, not: "..tostring(justification), level+1) |
end |
return true |
end |
function tipPrototype:SetColumnLayout(numColumns, ...) |
if type(numColumns) ~= "number" or numColumns < 1 then |
error("number of columns must be a positive number, not: "..tostring(numColumns), 2) |
end |
for i = 1, numColumns do |
local justification = select(i, ...) or "LEFT" |
checkJustification(justification, 2) |
if self.columns[i] then |
self.columns[i].justification = justification |
else |
self:AddColumn(justification) |
end |
end |
end |
function tipPrototype:AddColumn(justification) |
justification = justification or "LEFT" |
checkJustification(justification, 2) |
local colNum = #self.columns + 1 |
local column = self.columns[colNum] or AcquireFrame(self) |
column:SetParent(self.scrollChild) |
column.justification = justification |
column.width = 0 |
column:SetWidth(1) |
column:SetPoint("TOP", self.scrollChild) |
column:SetPoint("BOTTOM", self.scrollChild) |
if colNum > 1 then |
column:SetPoint("LEFT", self.columns[colNum - 1], "RIGHT", CELL_MARGIN_H, 0) |
SetTooltipSize(self, self.width + CELL_MARGIN_H, self.height) |
else |
column:SetPoint("LEFT", self.scrollChild) |
end |
column:Show() |
self.columns[colNum] = column |
return colNum |
end |
------------------------------------------------------------------------------ |
-- Scrollbar data and functions |
------------------------------------------------------------------------------ |
local sliderBackdrop = { |
["bgFile"] = [[Interface\Buttons\UI-SliderBar-Background]], |
["edgeFile"] = [[Interface\Buttons\UI-SliderBar-Border]], |
["tile"] = true, |
["edgeSize"] = 8, |
["tileSize"] = 8, |
["insets"] = { |
["left"] = 3, |
["right"] = 3, |
["top"] = 3, |
["bottom"] = 3, |
}, |
} |
local function slider_OnValueChanged(self) |
self.scrollFrame:SetVerticalScroll(self:GetValue()) |
end |
local function tooltip_OnMouseWheel(self, delta) |
local slider = self.slider |
local currentValue = slider:GetValue() |
local minValue,maxValue = slider:GetMinMaxValues() |
if delta < 0 and currentValue < maxValue then |
slider:SetValue(min(maxValue, currentValue + 10)) |
elseif delta > 0 and currentValue > minValue then |
slider:SetValue(max(minValue, currentValue - 10)) |
end |
end |
-- will resize the tooltip to fit the screen and show a scrollbar if needed |
function tipPrototype:UpdateScrolling(maxheight) |
self:SetClampedToScreen(false) |
-- all data is in the tooltip; fix colspan width and prevent the layout cleaner from messing up the tooltip later |
LayoutColspans(self) |
layoutCleaner.registry[self] = nil |
local topside = self:GetTop() |
local bottomside = self:GetBottom() |
local screensize = UIParent:GetHeight() |
local tipsize = topside - bottomside |
-- if the tooltip would be too high, limit its height and show the slider |
if bottomside < 0 or topside > screensize or (maxheight and tipsize > maxheight) then |
local shrink = (bottomside < 0 and (5 - bottomside) or 0) + (topside > screensize and (topside - screensize + 5) or 0) |
if maxheight and tipsize - shrink > maxheight then |
shrink = tipsize - maxheight |
end |
self:SetHeight(2 * TOOLTIP_PADDING + self.height - shrink) |
self:SetWidth(2 * TOOLTIP_PADDING + self.width + 20) |
self.scrollFrame:SetPoint("RIGHT", self, "RIGHT", -(TOOLTIP_PADDING + 20), 0) |
if not self.slider then |
local slider = CreateFrame("Slider", nil, self) |
self.slider = slider |
slider:SetOrientation("VERTICAL") |
slider:SetPoint("TOPRIGHT", self, "TOPRIGHT", -TOOLTIP_PADDING, -TOOLTIP_PADDING) |
slider:SetPoint("BOTTOMRIGHT", self, "BOTTOMRIGHT", -TOOLTIP_PADDING, TOOLTIP_PADDING) |
slider:SetBackdrop(sliderBackdrop) |
slider:SetThumbTexture([[Interface\Buttons\UI-SliderBar-Button-Vertical]]) |
slider:SetMinMaxValues(0, 1) |
slider:SetValueStep(1) |
slider:SetWidth(12) |
slider.scrollFrame = self.scrollFrame |
slider:SetScript("OnValueChanged", slider_OnValueChanged) |
slider:SetValue(0) |
end |
self.slider:SetMinMaxValues(0, shrink) |
self.slider:Show() |
self:EnableMouseWheel(true) |
self:SetScript("OnMouseWheel", tooltip_OnMouseWheel) |
else |
self:SetHeight(2 * TOOLTIP_PADDING + self.height) |
self:SetWidth(2 * TOOLTIP_PADDING + self.width) |
self.scrollFrame:SetPoint("RIGHT", self, "RIGHT", -TOOLTIP_PADDING, 0) |
if self.slider then |
self.slider:SetValue(0) |
self.slider:Hide() |
self:EnableMouseWheel(false) |
self:SetScript("OnMouseWheel", nil) |
end |
end |
end |
------------------------------------------------------------------------------ |
-- Tooltip methods for changing its contents. |
------------------------------------------------------------------------------ |
function tipPrototype:Clear() |
for i, line in ipairs(self.lines) do |
for j, cell in pairs(line.cells) do |
if cell then ReleaseCell(cell) end |
end |
ReleaseTable(line.cells) |
line.cells = nil |
ReleaseFrame(line) |
self.lines[i] = nil |
end |
for i, column in ipairs(self.columns) do |
column.width = 0 |
column:SetWidth(1) |
end |
wipe(self.colspans) |
ResetTooltipSize(self) |
end |
local function checkFont(font, level, silent) |
if not font or type(font) ~= 'table' or type(font.IsObjectType) ~= 'function' or not font:IsObjectType("Font") then |
if silent then return false end |
error("font must be Font instance, not: "..tostring(font), level+1) |
end |
return true |
end |
function tipPrototype:SetFont(font) |
checkFont(font, 2) |
self.regularFont = font |
end |
function tipPrototype:GetFont() return self.regularFont end |
function tipPrototype:SetHeaderFont(font) |
checkFont(font, 2) |
self.headerFont = font |
end |
function tipPrototype:GetHeaderFont() return self.headerFont end |
function SetTooltipSize(tooltip, width, height) |
tooltip:SetHeight(2 * TOOLTIP_PADDING + height) |
tooltip.scrollChild:SetHeight(height) |
tooltip.height = height |
tooltip:SetWidth(2 * TOOLTIP_PADDING + width) |
tooltip.scrollChild:SetWidth(width) |
tooltip.width = width |
end |
-- Add 2 pixels to height so dangling letters (g, y, p, j, etc) are not clipped. |
function ResetTooltipSize(tooltip) |
SetTooltipSize(tooltip, max(0, (CELL_MARGIN_H * (#tooltip.columns - 1)) + (CELL_MARGIN_H / 2)), 2) |
end |
local function EnlargeColumn(tooltip, column, width) |
if width > column.width then |
SetTooltipSize(tooltip, tooltip.width + width - column.width, tooltip.height) |
column.width = width |
column:SetWidth(width) |
end |
end |
function LayoutColspans(tooltip) |
local columns = tooltip.columns |
for colRange, width in pairs(tooltip.colspans) do |
local left, right = colRange:match("^(%d+)%-(%d+)$") |
left, right = tonumber(left), tonumber(right) |
for col = left, right-1 do |
width = width - columns[col].width - CELL_MARGIN_H |
end |
EnlargeColumn(tooltip, columns[right], width) |
end |
wipe(tooltip.colspans) |
end |
local function _SetCell(tooltip, lineNum, colNum, value, font, justification, colSpan, provider, ...) |
local line = tooltip.lines[lineNum] |
local cells = line.cells |
-- Unset: be quick |
if value == nil then |
local cell = cells[colNum] |
if cell then |
for i = colNum, colNum + cell._colSpan - 1 do |
cells[i] = nil |
end |
ReleaseCell(cell) |
end |
return lineNum, colNum |
end |
-- Check previous cell |
local cell |
local prevCell = cells[colNum] |
if prevCell then |
-- There is a cell here |
font = font or prevCell._font |
justification = justification or prevCell._justification |
colSpan = colSpan or prevCell._colSpan |
-- Clear the currently marked colspan |
for i = colNum + 1, colNum + prevCell._colSpan - 1 do |
cells[i] = nil |
end |
if provider == nil or prevCell._provider == provider then |
-- Reuse existing cell |
cell = prevCell |
provider = cell._provider |
else |
-- A new cell is required |
cells[colNum] = ReleaseCell(prevCell) |
end |
elseif prevCell == nil then |
-- Creating a new cell, using meaningful defaults. |
provider = provider or tooltip.labelProvider |
font = font or tooltip.regularFont |
justification = justification or tooltip.columns[colNum].justification or "LEFT" |
colSpan = colSpan or 1 |
else |
error("overlapping cells at column "..colNum, 3) |
end |
local tooltipWidth = #tooltip.columns |
local rightColNum |
if colSpan > 0 then |
rightColNum = colNum + colSpan - 1 |
if rightColNum > tooltipWidth then |
error("ColSpan too big, cell extends beyond right-most column", 3) |
end |
else |
-- Zero or negative: count back from right-most columns |
rightColNum = max(colNum, tooltipWidth + colSpan) |
-- Update colspan to its effective value |
colSpan = 1 + rightColNum - colNum |
end |
-- Cleanup colspans |
for i = colNum + 1, rightColNum do |
local cell = cells[i] |
if cell then |
ReleaseCell(cell) |
elseif cell == false then |
error("overlapping cells at column "..i, 3) |
end |
cells[i] = false |
end |
-- Create the cell |
if not cell then |
cell = AcquireCell(tooltip, provider) |
cells[colNum] = cell |
end |
-- Anchor the cell |
cell:SetPoint("LEFT", tooltip.columns[colNum]) |
cell:SetPoint("RIGHT", tooltip.columns[rightColNum]) |
cell:SetPoint("TOP", line) |
cell:SetPoint("BOTTOM", line) |
-- Store the cell settings directly into the cell |
-- That's a bit risky but is really cheap compared to other ways to do it |
cell._font, cell._justification, cell._colSpan, cell._line, cell._column = font, justification, colSpan, lineNum, colNum |
-- Setup the cell content |
local width, height = cell:SetupCell(tooltip, value, justification, font, ...) |
cell:Show() |
if colSpan > 1 then |
-- Postpone width changes until the tooltip is shown |
local colRange = colNum.."-"..rightColNum |
tooltip.colspans[colRange] = max(tooltip.colspans[colRange] or 0, width) |
layoutCleaner:RegisterForCleanup(tooltip) |
else |
-- Enlarge the column and tooltip if need be |
EnlargeColumn(tooltip, tooltip.columns[colNum], width) |
end |
-- Enlarge the line and tooltip if need be |
if height > line.height then |
SetTooltipSize(tooltip, tooltip.width, tooltip.height + height - line.height) |
line.height = height |
line:SetHeight(height) |
end |
if rightColNum < tooltipWidth then |
return lineNum, rightColNum + 1 |
else |
return lineNum, nil |
end |
end |
local function CreateLine(tooltip, font, ...) |
if #tooltip.columns == 0 then |
error("column layout should be defined before adding line", 3) |
end |
local lineNum = #tooltip.lines + 1 |
local line = tooltip.lines[lineNum] or AcquireFrame(tooltip) |
line:SetPoint('LEFT', tooltip.scrollChild) |
line:SetPoint('RIGHT', tooltip.scrollChild) |
if lineNum > 1 then |
line:SetPoint('TOP', tooltip.lines[lineNum-1], 'BOTTOM', 0, -CELL_MARGIN_V) |
SetTooltipSize(tooltip, tooltip.width, tooltip.height + CELL_MARGIN_V) |
else |
line:SetPoint('TOP', tooltip.scrollChild) |
end |
tooltip.lines[lineNum] = line |
line.cells = line.cells or AcquireTable() |
line.height = 0 |
line:SetHeight(1) |
line:Show() |
local colNum = 1 |
for i = 1, #tooltip.columns do |
local value = select(i, ...) |
if value ~= nil then |
lineNum, colNum = _SetCell(tooltip, lineNum, i, value, font, nil, 1, tooltip.labelProvider) |
end |
end |
return lineNum, colNum |
end |
function tipPrototype:AddLine(...) |
return CreateLine(self, self.regularFont, ...) |
end |
function tipPrototype:AddHeader(...) |
return CreateLine(self, self.headerFont, ...) |
end |
local GenericBackdrop = { |
bgFile = "Interface\\Tooltips\\UI-Tooltip-Background", |
} |
function tipPrototype:AddSeparator(height, r, g, b, a) |
local lineNum, colNum = self:AddLine() |
local line = self.lines[lineNum] |
local color = NORMAL_FONT_COLOR |
height = height or 1 |
SetTooltipSize(self, self.width, self.height + height) |
line.height = height |
line:SetHeight(height) |
line:SetBackdrop(GenericBackdrop) |
line:SetBackdropColor(r or color.r, g or color.g, b or color.b, a or 1) |
return lineNum, colNum |
end |
function tipPrototype:SetColumnColor(colNum, r, g, b, a) |
if type(colNum) ~= "number" then |
error("column number must be a number, not: "..tostring(colNum), 2) |
elseif colNum < 1 or colNum > #self.columns then |
error("column number out of range: "..tostring(colNum), 2) |
end |
local column = self.columns[colNum] |
local sr, sg, sb, sa = self:GetBackdropColor() |
column:SetBackdrop(GenericBackdrop) |
column:SetBackdropColor(r or sr, g or sg, b or sb, a or sa) |
end |
function tipPrototype:SetLineColor(lineNum, r, g, b, a) |
if type(lineNum) ~= "number" then |
error("line number must be a number, not: "..tostring(lineNum), 2) |
elseif lineNum < 1 or lineNum > #self.lines then |
error("line number out of range: "..tostring(lineNum), 2) |
end |
local line = self.lines[lineNum] |
local sr, sg, sb, sa = self:GetBackdropColor() |
line:SetBackdrop(GenericBackdrop) |
line:SetBackdropColor(r or sr, g or sg, b or sb, a or sa) |
end |
function tipPrototype:SetCell(lineNum, colNum, value, ...) |
-- Mandatory argument checking |
if type(lineNum) ~= "number" then |
error("line number must be a number, not: "..tostring(lineNum), 2) |
elseif lineNum < 1 or lineNum > #self.lines then |
error("line number out of range: "..tostring(lineNum), 2) |
elseif type(colNum) ~= "number" then |
error("column number must be a number, not: "..tostring(colNum), 2) |
elseif colNum < 1 or colNum > #self.columns then |
error("column number out of range: "..tostring(colNum), 2) |
end |
-- Variable argument checking |
local font, justification, colSpan, provider |
local i, arg = 1, ... |
if arg == nil or checkFont(arg, 2, true) then |
i, font, arg = 2, ... |
end |
if arg == nil or checkJustification(arg, 2, true) then |
i, justification, arg = i + 1, select(i, ...) |
end |
if arg == nil or type(arg) == 'number' then |
i, colSpan, arg = i + 1, select(i, ...) |
end |
if arg == nil or type(arg) == 'table' and type(arg.AcquireCell) == 'function' then |
i, provider = i + 1, arg |
end |
return _SetCell(self, lineNum, colNum, value, font, justification, colSpan, provider, select(i, ...)) |
end |
function tipPrototype:GetLineCount() return #self.lines end |
function tipPrototype:GetColumnCount() return #self.columns end |
------------------------------------------------------------------------------ |
-- Auto-hiding feature |
------------------------------------------------------------------------------ |
-- Script of the auto-hiding child frame |
local function AutoHideTimerFrame_OnUpdate(self, elapsed) |
if MouseIsOver(self:GetParent()) or (self.alternateFrame and MouseIsOver(self.alternateFrame)) then |
self.elapsed = 0 |
else |
self.elapsed = self.elapsed + elapsed |
if self.elapsed > self.delay then |
lib:Release(self:GetParent()) |
end |
end |
end |
-- Usage: |
-- :SetAutoHideDelay(0.25) => hides after 0.25sec outside of the tooltip |
-- :SetAutoHideDelay(0.25, someFrame) => hides after 0.25sec outside of both the tooltip and someFrame |
-- :SetAutoHideDelay() => disable auto-hiding (default) |
function tipPrototype:SetAutoHideDelay(delay, alternateFrame) |
delay = tonumber(delay) or 0 |
local timerFrame = self.autoHideTimerFrame |
if delay > 0 then |
if not timerFrame then |
timerFrame = AcquireFrame(self) |
timerFrame:SetScript("OnUpdate", AutoHideTimerFrame_OnUpdate) |
self.autoHideTimerFrame = timerFrame |
end |
timerFrame.elapsed = 0 |
timerFrame.delay = delay |
timerFrame.alternateFrame = alternateFrame |
timerFrame:Show() |
elseif timerFrame then |
self.autoHideTimerFrame = nil |
timerFrame.alternateFrame = nil |
timerFrame:SetScript("OnUpdate", nil) |
ReleaseFrame(timerFrame) |
end |
end |
------------------------------------------------------------------------------ |
-- "Smart" Anchoring |
------------------------------------------------------------------------------ |
local function GetTipAnchor(frame) |
local x,y = frame:GetCenter() |
if not x or not y then return "TOPLEFT", "BOTTOMLEFT" end |
local hhalf = (x > UIParent:GetWidth() * 2/3) and "RIGHT" or (x < UIParent:GetWidth() / 3) and "LEFT" or "" |
local vhalf = (y > UIParent:GetHeight() / 2) and "TOP" or "BOTTOM" |
return vhalf..hhalf, frame, (vhalf == "TOP" and "BOTTOM" or "TOP")..hhalf |
end |
function tipPrototype:SmartAnchorTo(frame) |
if not frame then |
error("Invalid frame provided.", 2) |
end |
self:ClearAllPoints() |
self:SetClampedToScreen(true) |
self:SetPoint(GetTipAnchor(frame)) |
end |
------------------------------------------------------------------------------ |
-- Debug slashcmds |
------------------------------------------------------------------------------ |
--[===[@debug@ |
local print = print |
local function PrintStats() |
local tipCache = tostring(#tooltipHeap) |
local frameCache = tostring(#frameHeap) |
local tableCache = tostring(#tableHeap) |
print("Tooltips used: "..usedTooltips..", Cached: "..tipCache..", Total: "..tipCache + usedTooltips) |
print("Frames used: "..usedFrames..", Cached: "..frameCache..", Total: "..frameCache + usedFrames) |
print("Tables used: "..usedTables..", Cached: "..tableCache..", Total: "..tableCache + usedTables) |
local header = false |
for k, v in pairs(activeTooltips) do |
if not header then |
print("Active tooltips:") |
header = true |
end |
print("- "..k) |
end |
end |
SLASH_LibQTip1 = "/qtip" |
SlashCmdList["LibQTip"] = PrintStats |
--@end-debug@]===] |
-- LibStub is a simple versioning stub meant for use in Libraries. http://www.wowace.com/wiki/LibStub for more info |
-- LibStub is hereby placed in the Public Domain |
-- Credits: Kaelten, Cladhaire, ckknight, Mikk, Ammo, Nevcairiel, joshborke |
-- Very minor modification for WAR use by Aiiane |
local LIBSTUB_MAJOR, LIBSTUB_MINOR = "LibStub", 3 -- NEVER MAKE THIS AN SVN REVISION! IT NEEDS TO BE USABLE IN ALL REPOS! |
local LibStub = _G[LIBSTUB_MAJOR] |
local strmatch = string.match |
-- Check to see is this version of the stub is obsolete |
if not LibStub or LibStub.minor < LIBSTUB_MINOR then |
LibStub = LibStub or {libs = {}, minors = {} } |
_G[LIBSTUB_MAJOR] = LibStub |
LibStub.minor = LIBSTUB_MINOR |
-- LibStub:NewLibrary(major, minor) |
-- major (string) - the major version of the library |
-- minor (string or number ) - the minor version of the library |
-- |
-- returns nil if a newer or same version of the lib is already present |
-- returns empty library object or old library object if upgrade is needed |
function LibStub:NewLibrary(major, minor) |
assert(type(major) == "string", "Bad argument #2 to `NewLibrary' (string expected)") |
minor = assert(tonumber(strmatch(minor, "%d+")), "Minor version must either be a number or contain a number.") |
local oldminor = self.minors[major] |
if oldminor and oldminor >= minor then return nil end |
self.minors[major], self.libs[major] = minor, self.libs[major] or {} |
return self.libs[major], oldminor |
end |
-- LibStub:GetLibrary(major, [silent]) |
-- major (string) - the major version of the library |
-- silent (boolean) - if true, library is optional, silently return nil if its not found |
-- |
-- throws an error if the library can not be found (except silent is set) |
-- returns the library object if found |
function LibStub:GetLibrary(major, silent) |
if not self.libs[major] and not silent then |
error(("Cannot find a library instance of %q."):format(tostring(major)), 2) |
end |
return self.libs[major], self.minors[major] |
end |
-- LibStub:IterateLibraries() |
-- |
-- Returns an iterator for the currently registered libraries |
function LibStub:IterateLibraries() |
return pairs(self.libs) |
end |
setmetatable(LibStub, { __call = LibStub.GetLibrary }) |
end |