LibEffects
LibEffects is a library that can add effects to your addon.
Features
- Screen Shake
- Screen Flash
- Play Sounds
Implementing
Use the following code to implement LibEffects-1.0:
local Effects = LibStub("LibEffects-1.0")
or you could also use it as a mix in by doing:
MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "LibEffects-1.0")
Flash()
To make the screen border flash use the following code:
Effects:Flash()
Shake()
To make the screen shake use the following code:
Effects:Shake()
AddSound(unique name, location)
AddSound() adds a sound to the sounds array, making it easy to play sounds later on.
To add a sound, use the following code:
Effects:AddSound("DoorOpen",[[Sound\Doodad\PVP_Lordaeron_Door_Open.wav]])
Remember, the name must be unique.
PlaySound(unique name)
PlaySound() plays the sound with the name specified, to do so use this code:
Effects:PlaySound("DoorOpen")
UpdateSound(unique name, location)
UpdateSound() updates the sound file location, like so:
Effects:UpdateSound("DoorOpen",[[Sound\Doodad\PortcullisActive_Closed.wav]])
------------------------------------------------------------------------
r4 | xocide | 2009-01-05 04:04:19 +0000 (Mon, 05 Jan 2009) | 1 line
Changed paths:
A /tags/beta1 (from /trunk:3)
Tagging as beta1
------------------------------------------------------------------------
r3 | xocide | 2008-12-27 14:03:00 +0000 (Sat, 27 Dec 2008) | 1 line
Changed paths:
M /trunk/LibEffects-1.0/LibEffects-1.0.lua
Added :AddSound(), :PlaySound() and :UpdateSound()
------------------------------------------------------------------------
r2 | xocide | 2008-12-27 13:21:32 +0000 (Sat, 27 Dec 2008) | 2 lines
Changed paths:
A /trunk/.pkgmeta
A /trunk/LibEffects-1.0
A /trunk/LibEffects-1.0/LibEffects-1.0.lua
A /trunk/LibEffects-1.0/lib.xml
A /trunk/LibEffects-1.0.toc
First Commit.
Contains the Flash() and Shake() functions, Play Sound function soon.
------------------------------------------------------------------------
r1 | root | 2008-12-27 12:44:19 +0000 (Sat, 27 Dec 2008) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"libeffects/mainline: Initial Import"
------------------------------------------------------------------------
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...
