WoW:API PlaySound: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Minor spelling corrections)
m (Move page script moved page API PlaySound to API PlaySound without leaving a redirect)
 
(7 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<center>'''PlaySound''' ''-Documentation by [[user:coder_1024|coder_1024]] taken from Dhargo's post on the official forums-''</center>
{{wowapi}} __NOTOC__
 
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
 
PlaySound(SoundName);
 
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
 
Play one of a set of built-in sounds.  Other players will not hear the sound.
Play one of a set of built-in sounds.  Other players will not hear the sound.
PlaySound("SoundName", "channel");


----
==Parameters==
;''Arguments''
===Arguments===
 
<!-- List each argument, together with its type -->
 
:(SoundName)
:;SoundName : String - One of the below sound names (not all these actually make a sound)
:;SoundName : String - One of the below sound names (not all these actually make a sound)
  PVPENTERQUEUE - Sound for entering BG queue and when it refreshes periodicly
  PVPENTERQUEUE - Sound for entering BG queue and when it refreshes periodicly
  PVPTHROUGHQUEUE - You are eligible to enter the battleground!
  PVPTHROUGHQUEUE - You are eligible to enter the battleground!
Line 191: Line 180:
  igAbilityIconPickup  
  igAbilityIconPickup  
  igAbilityIconDrop  
  igAbilityIconDrop  
TalentScreenOpen
TalentScreenClose
  igCharacterInfoOpen  
  igCharacterInfoOpen  
  igCharacterInfoClose  
  igCharacterInfoClose  
Line 247: Line 238:
  igPVPUpdate
  igPVPUpdate
  ReadyCheck
  ReadyCheck
RaidWarning
AuctionWindowOpen
AuctionWindowClose


----
:;channel : String - Either "Master" (this will play the sound also with disabled sounds like before 4.0.1), "SFX", "Ambience", "Music".
;''Example''
 
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
 
PlaySound("LEVELUPSOUND");
 
----
;''Details''
 
<!-- Details not appropriate for the main description can go here -->


----
==Example==
{{Template:WoW API}}
PlaySound("LEVELUPSOUND", "master");

Latest revision as of 04:47, 15 August 2023

WoW API < PlaySound

Play one of a set of built-in sounds. Other players will not hear the sound.

PlaySound("SoundName", "channel");

Parameters[edit]

Arguments[edit]

SoundName
String - One of the below sound names (not all these actually make a sound)
PVPENTERQUEUE - Sound for entering BG queue and when it refreshes periodicly
PVPTHROUGHQUEUE - You are eligible to enter the battleground!
GLUESCREENSMALLBUTTONMOUSEDOWN 
GLUESCREENSMALLBUTTONMOUSEUP 
GLUESCREENSMALLBUTTONMOUSEOVER 
GLUESCREENMEDIUMBUTTONMOUSEDOWN 
GLUESCREENMEDIUMBUTTONMOUSEUP 
GLUESCREENMEDIUMBUTTONMOUSEOVER 
GLUESCREENLARGEBUTTONMOUSEDOWN 
GLUESCREENLARGEBUTTONMOUSEUP 
GLUESCREENLARGEBUTTONMOUSEOVER 
GLUESCREENEDITBOXKEYCLICK 
GLUECHECKBOXMOUSEDOWN 
GLUECHECKBOXMOUSEUP 
GLUECHECKBOXMOUSEOVER 
GLUECHARCUSTOMIZATIONMOUSEDOWN 
GLUECHARCUSTOMIZATIONMOUSEUP 
GLUECHARCUSTOMIZATIONMOUSEOVER 
GLUESCROLLBUTTONMOUSEDOWN 
GLUESCROLLBUTTONMOUSEUP 
GLUESCROLLBUTTONMOUSEOVER 
GAMEABILITYBUTTONMOUSEDOWN 
GAMESPELLBUTTONMOUSEDOWN 
GAMEWINDOWOPEN 
GAMEWINDOWCLOSE 
GAMEDIALOGOPEN 
GAMEDIALOGCLOSE 
GAMENEWWINDOWTAB 
GAMESCREENSMALLBUTTONMOUSEDOWN 
GAMESCREENSMALLBUTTONMOUSEUP 
GAMESCREENSMALLBUTTONMOUSEOVER 
GAMESCREENMEDIUMBUTTONMOUSEDOWN 
GAMESCREENMEDIUMBUTTONMOUSEUP 
GAMESCREENMEDIUMBUTTONMOUSEOVER 
GAMESCREENLARGEBUTTONMOUSEDOWN 
GAMESCREENLARGEBUTTONMOUSEUP 
GAMESCREENLARGEBUTTONMOUSEOVER 
GAMETARGETFRIENDLYUNIT 
GAMETARGETHOSTILEUNIT 
GAMETARGETNEUTRALUNIT 
GAMEHIGHLIGHTFRIENDLYUNIT 
GAMEHIGHLIGHTHOSTILEUNIT 
GAMEHIGHLIGHTNEUTRALUNIT 
GAMEINITIALATTACK 
GAMEERROROUTOFRANGE 
GAMEERROROUTOFMANA 
GAMEERRORUNABLETOEQUIP 
GAMEERRORINVALIDTARGET 
ACTIONBARBUTTONDOWN 
MAINBUTTONBARMENU 
MINIMAPZOOMOUT 
MINIMAPZOOMIN 
MINIMAPOPEN 
MINIMAPCLOSE 
BAGMENUBUTTONPRESS 
LOOTWINDOWOPEN 
LOOTWINDOWCLOSE 
LOOTWINDOWCOINSOUND 
ITEMWEAPONSOUND 
ITEMARMORSOUND 
ITEMGENERICSOUND 
LEVELUPSOUND 
GLUECREATECHARACTERBUTTON 
GLUEENTERWORLDBUTTON 
SPELLBOOKOPEN 
SPELLBOOKCLOSE 
SPELLBOOKCHANGEPAGE 
PAPERDOLLOPEN 
PAPERDOLLCLOSE 
QUESTADDED 
QUESTCOMPLETED 
QUESTLOGOPEN 
QUESTLOGCLOSE 
GLUEGENERICBUTTONPRESS 
GAMEGENERICBUTTONPRESS 
INTERFACESOUND_MONEYFRAMEOPEN 
INTERFACESOUND_MONEYFRAMECLOSE 
INTERFACESOUND_CHARWINDOWOPEN 
INTERFACESOUND_CHARWINDOWCLOSE 
INTERFACESOUND_CHARWINDOWTAB 
INTERFACESOUND_GAMEMENUOPEN 
INTERFACESOUND_GAMEMENUCLOSE 
INTERFACESOUND_LOSTTARGETUNIT 
INTERFACESOUND_BACKPACKOPEN 
INTERFACESOUND_BACKPACKCLOSE 
INTERFACESOUND_GAMESCROLLBUTTON 
INTERFACESOUND_CURSORGRABOBJECT 
INTERFACESOUND_CURSORDROPOBJECT 
SHEATHINGSHIELDSHEATHE 
SHEATHINGWOODWEAPONSHEATHE 
SHEATHINGMETALWEAPONSHEATHE 
SHEATHINGWOODWEAPONUNSHEATHE 
SHEATHINGMETALWEAPONUNSHEATHE 
SHEATHINGSHIELDUNSHEATHE 
igCreatureAggroDeselect 
igQuestListOpen 
igQuestListClose 
igQuestListSelect 
igQuestListComplete 
igQuestCancel 
igPlayerInvite 
igPlayerInviteAccept 
igPlayerInviteDecline 
GAMEERRORUNABLETOEQUIP 
ITEMGENERICSOUND 
GAMEERRORINVALIDTARGET 
LEVELUP 
GAMEERROROUTOFRANGE 
QUESTADDED 
MONEYFRAMEOPEN 
MONEYFRAMECLOSE 
LOOTWINDOWOPEN 
LOOTWINDOWCLOSE 
LOOTWINDOWCOINSOUND 
GAMEHIGHLIGHTHOSTILEUNIT 
GAMEHIGHLIGHTNEUTRALUNIT 
GAMEHIGHLIGHTFRIENDLYUNIT 
INTERFACESOUND_LOSTTARGETUNIT 
INTERFACESOUND_CURSORGRABOBJECT 
INTERFACESOUND_CURSORDROPOBJECT 
GAMESCREENMEDIUMBUTTONMOUSEDOWN 
GAMEABILITYACTIVATE 
GAMESPELLACTIVATE 
gsTitleEnterWorld 
gsTitleOptions 
gsTitleQuit 
gsTitleCredits 
gsTitleIntroMovie 
gsTitleOptionScreenResolution 
gsTitleOption16bit 
gsTitleOption32bit 
gsTitleOptionOpenGL 
gsTitleOptionDirect3D 
gsTitleOptionFullScreenMode 
gsTitleOptionOK 
gsTitleOptionExit 
gsLogin 
gsLoginNewAccount 
gsLoginChangeRealm 
gsLoginExit 
gsLoginChangeRealmOK 
gsLoginChangeRealmSelect 
gsLoginChangeRealmCancel 
gsCharacterSelection 
gsCharacterSelectionEnterWorld 
gsCharacterSelectionDelCharacter 
gsCharacterSelectionAcctOptions 
gsCharacterSelectionExit 
gsCharacterSelectionCreateNew 
gsCharacterCreationClass 
gsCharacterCreationRace 
gsCharacterCreationGender 
gsCharacterCreationLook 
gsCharacterCreationCreateChar 
gsCharacterCreationCancel 
igCurrentActiveSpell
igMiniMapOpen 
igMiniMapClose 
igMiniMapZoomIn 
igMiniMapZoomOut 
igChatEmoteButton 
igChatScrollUp 
igChatScrollDown 
igChatBottom 
igSpellBookOpen 
igSpellBookClose  
igSpellBokPageTur n 
igSpellBookSpellIconPickup 
igSpellBookSpellIconDrop 
igAbilityOpen 
igAbilityClose 
igAbiliityPageTurn 
igAbilityIconPickup 
igAbilityIconDrop 
TalentScreenOpen
TalentScreenClose
igCharacterInfoOpen 
igCharacterInfoClose 
igCharacterInfoTab 
igCharacterInfoScrollUp 
igCharacterInfoScrollDown 
igQuestLogOpen 
igQuestLogClose 
igQuestLogAbandonQuest 
igQuestFailed 
igSocialOepn                 [This is Not a Wiki Typo, "igSocialOepn" works in game]
igSocialClose 
igMainMenuOpen 
igMainMenuClose 
igMainMenuOption 
igMainMenuLogout 
igMainMenuQuit 
igMainMenuContinue 
igMainMenuOptionCheckBoxOn 
igMainMenuOptionCheckBoxOff 
igMainMenuOptionFaerTab 
igInventoryOepn               [This is Not a Wiki Typo, "igInventoryOepn" works in game]
igInventoryClose 
igInventoryRotateCharacter 
igBackPackOpen 
igBackPackClose 
igBackPackCoinSelect 
igBackPackCoinOK 
igBackPackCoinCancel 
igCharacterNPCSelect 
igCharacterNPCDeselect 
igCharacterSelect 
igCharacterDeselect 
igCreatureNeutralSelect 
igCreatureNeutralDeselect 
igCreatureAggroSelect 
UChatScrollButton 
Deathbind Sound 
LOOTWINDOWOPENEMPTY 
TaxiNodeDiscovered 
UnwrapGift 
TellMessage 
WriteQuest 
MapPing 
igBonusBarOpen 
FriendJoinGame 
Fishing Reel in 
HumanExploration 
OrcExploration 
UndeadExploration 
TaurenExploration 
TrollExploration 
NightElfExploration 
GnomeExploration 
DwarfExploration 
igPVPUpdate
ReadyCheck
RaidWarning
AuctionWindowOpen
AuctionWindowClose
channel
String - Either "Master" (this will play the sound also with disabled sounds like before 4.0.1), "SFX", "Ambience", "Music".

Example[edit]

PlaySound("LEVELUPSOUND", "master");