Chapter 27
API Reference
619
CombatLogResetFilter
Removesany filtersapplied to the combat log.
CombatLogSetCurrentEntry
Setsthe ‘‘cursor’’ positionused by other CombatLog functions.
CombatLogSetCurrentEntry(index[, ignoreFilter])
Informationabout the entry at the ‘‘cursor’’ positioncan be retrieved with
CombatLogGetCurrentEntry().Thatfunctionthenadvancesthecursorto
the next entry, so calling it repeatedly returnsall information inthe combat log;
this function canbe used to ‘‘rewind’’ the combat log to retrieve information
about earlier events.
The argumentindex can be positive or negative: positive indices start at the
beginning of the combat log (oldest events) and count up to the end (newest
events); negative indicesstart at-1 for the newest event and count backwards
to-CombatLogGetNumEntries(ignoreFilter) for the oldest.
Arguments:
index—Indexofacombatlogevent(between1and CombatLogGetNum
Entries(ignoreFilter),orbetween -1and -CombatLogGetNumEntries
(ignoreFilter))(number)
ignoreFilter(optional)— Truetousetheentiresavedcombatloghistory;
falseoromittedtouseonlyeventsmatchingthecurrentfilter(boolean)
CombatLogSetRetentionTime
Setsthe amount of time combat log entries willbe stored.
CombatLogSetRetentionTime(seconds)
Arguments:
seconds—Thedesiredtime(number)
CombatLog_Object_IsA
Returnswhether an entity from the combat log matchesa given filter.
isMatch=CombatLog_Object_IsA(unitFlags,mask)
Arguments:
unitFlags—Sourceordestinationunitflagsfromacombatlogentry(number,
bitfield)
mask—Oneofthefollowingglobalconstants:(number,bitfield)
COMBATLOG_FILTER_EVERYTHING—Anyentity
COMBATLOG_FILTER_FRIENDLY_UNITS—Entityisafriendlyunit
COMBATLOG_FILTER_HOSTILE_PLAYERS—Entityisahostileplayerunit
COMBATLOG_FILTER_HOSTILE_UNITS—Entityisahostilenon-playerunit
COMBATLOG_FILTER_ME—Entityistheplayer
COMBATLOG_FILTER_MINE—Entityisanon-unitobjectbelongingtothe
player; e.g. a totem
COMBATLOG_FILTER_MY_PET—Entityistheplayer’spet
COMBATLOG_FILTER_NEUTRAL_UNITS—Entityisaneutralunit
Rearrange pages in pdf reader - re-order PDF pages in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Support Customizing Page Order of PDF Document in C# Project
how to move pdf pages around; pdf change page order
Rearrange pages in pdf reader - VB.NET PDF Page Move Library: re-order PDF pages in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Sort PDF Document Pages Using VB.NET Demo Code
pdf reverse page order preview; pdf move pages
620
Part IV
Reference
COMBATLOG_FILTER_UNKNOWN_UNITS—Entityisaunitcurrentlyunknown
to the WoW client
Returns:
isMatch1iftheentityflagsmatchthegivenmask(1nil)
CombatTextSetActiveUnit
Setsthe main unit for display of floating combat text.
CombatTextSetActiveUnit(unit)
Certain types of floating combat text are only displayed for the ‘‘active’’unit
(normally the player): incoming damage, incoming heals, mana/energy
/power gains, low health/mana warnings, etc. This function isused by the
default UIto allowthe player’s vehicle to ‘‘stand in’’ for the player for
purposesof combat text; using this function with units other than ‘‘player’’or
‘‘vehicle’’ has no effect.
Arguments:
unit—Unittoshowmaincombattextfor(unitid)
ComplainChat
Reports achat message as spam.
ComplainChat(lineID)or ComplainChat(“name“ [, “text“])
Used inthe default UI whenright-clicking the name of a player in achat
message and choosing ‘‘Report Spam’’from the menu.
Arguments:
lineID—Uniqueidentifierofachatmessage(11thargumentreceivedwiththe
correspondingCHAT_MSG event) (number)
name—Nameofaplayertocomplainabout(string)
text(optional)—Specifictexttocomplainabout(string)
ComplainInboxItem
Reports amail message asspam.
ComplainInboxItem(mailID)
Arguments:
mailID—Indexofamessageintheplayer’sinbox(between1and
GetInboxNumItems())(number)
CompleteQuest
Beginsturning in aquest to aquestgiver.
Usable following theQUEST_PROGRESS event in whichit isdetermined
whether the player cancomplete the quest.
Doesnot complete the quest turn-inprocess; after calling thisfunction, the
QUEST_COMPLETEeventfiresasthequestgiverpresentsrewards(orsometimes
only closure to the quest narrative); following that event, theGetQuest
Reward()functionfinishestheturn-in.
C# TIFF: How to Reorder, Rearrange & Sort TIFF Pages Using C# Code
C# TIFF - Sort TIFF File Pages Order in C#.NET. Reorder, Rearrange and Sort TIFF Document Pages in C#.NET Application. C# TIFF Page Sorting Overview.
change pdf page order; reorder pages in pdf file
VB.NET TIFF: Modify TIFF File by Adding, Deleting & Sort TIFF
you want to change or rearrange current TIFF &ltsummary> ''' Sort TIFF document pages in designed powerful & profession imaging controls, PDF document, image
move pages in pdf acrobat; rearrange pdf pages reader
Chapter 27
API Reference
621
ConfirmAcceptQuest
Acceptsa quest started by another group member.
Usable following theQUEST_ACCEPT_CONFIRM event whichfireswhen another
member of the player’sparty or raid starts certain quests (e.g. escort quests).
Confirmation
ConfirmBindOnUse
Confirms using an item, if using the item causesit to become soulbound.
Usable in response to theUSE_BIND_CONFIRM which fireswhenthe player
attemptsto use a ‘‘Bind on Use’’item.
ConfirmBinder
Setsthe player’s Hearthstone to the current location.
Usable in response to theCONFIRM_BINDER event whichfiresupon speaking to
anInnkeeper (or similar NPC) and choosing the Hearthstone option.
Confirmation
ConfirmLootRoll
Confirms the player’s intent regarding an item up for loot rolling.
ConfirmLootRoll(id,rollType)
Usable after theCONFIRM_LOOT_ROLL event fires, warning that anitem binds
on pickup.
Arguments:
id—Indexofanitemcurrentlyupforlootrolling(asprovidedinthe
START_LOOT_ROLLevent)(number)
rollType—Typeofrollactiontoperform(number)
0—Pass (declinestheloot)
1—Roll‘‘need’’(winsifhighestroll)
2—Roll‘‘greed’’(winsifhighestrollandnoothermemberrolls‘‘need‘‘)
Confirmation
ConfirmLootSlot
Confirms picking up an item available asloot.
ConfirmLootSlot(slot)
Usable after theLOOT_BIND_CONFIRM event fires, warning that anitem binds
on pickup.
Arguments:
slot—Indexofalootslot(between1and GetNumLootItems())(number)
ConfirmReadyCheck
Respondsto a ready check.
ConfirmReadyCheck(ready)
Arguments:
readyTruetoreportas‘‘ready‘‘;falsetoreportas‘‘notready’’(true)
ConfirmSummon
Acceptsanoffered summons, teleporting the player to the summoner’s
location.
VB.NET PDF File & Page Process Library SDK for vb.net, ASP.NET
page directly. Moreover, when you get a PDF document which is out of order, you need to rearrange the PDF document pages. In these
move pages within pdf; change page order pdf preview
C# PowerPoint - How to Process PowerPoint
pages simply with a few lines of C# code. C# Codes to Sort Slides Order. If you want to use a very easy PPT slide dealing solution to sort and rearrange
how to move pages in a pdf document; rearrange pages in pdf
622
Part IV
Reference
Usable between whentheCONFIRM_SUMMON event fires(due to asummoning
spellcast by another player) and whenthe value returned byGetSummon
ConfirmTimeLeft()reacheszero.
Confirmation
ConfirmTalentWipe
Resets the player’s talents.
Usable following theCONFIRM_TALENT_WIPEevent which fireswhen the
player speaksto atrainer NPC and choosesto reset his or her talents.
ConsoleAddMessage
Printstext to the debug console.
The debugging console canbe activatedby launching WoW from the
command line with the ‘‘-console’’ option, then pressing the ‘‘`’’
(backtick/tilde) key ingame. Its usefulnessoutside of Blizzard internal
environmentsis limited.
ConsoleExec
Runs aconsole command.
ConsoleExec(“console_command“)
Used by the default UI to handle/console commands.
Arguments:
console_command—Theconsolecommandtorun(string)
ContainerIDToInventoryID
Returns theinventoryID corresponding to a givencontainerID.
inventoryID= ContainerIDToInventoryID(container)
Arguments:
container—Indexofoneoftheplayer’sbagsorothercontainers(number,
containerID)
Returns:
inventoryID—IdentifierforthecontainerusablewithInventoryAPIs(number,
inventoryID)
Example:
-- Switchestheplayer’sfirst bag (theone immediatelyleft of the
-- backpack)withthefirstbankbag(or putsthe bag into the bank
-- if thebank bagslot is empty)
localfirstBagSlot =ContainerIDToInventoryID(1)
localfirstBankBagSlot= ContainerIDToInventoryID(5)
PickupInventoryItem(firstBagSlot)
PickupInventoryItem(firstBankBagSlot)
ContainerRefundItemPurchase
Sellsanitem purchased with alternate currency back to avendor.
ContainerRefundItemPurchase(container,slot)
Items bought with alternate currency (honor points, arena points, or special
itemssuchasEmblems of Heroism and Dalaran Cooking Awards) canbe
VB.NET Word: How to Process MS Word in VB.NET Library in .NET
well programmed Word pages sorter to rearrange Word pages in extracting single or multiple Word pages at one & profession imaging controls, PDF document, image
reorder pages in pdf; how to reorder pages in pdf online
Process Images in Web Image Viewer | Online Tutorials
used document types are supported, including PDF, multi-page easy to process image and file pages with the deleting a thumbnail, and you can rearrange the file
how to rearrange pages in pdf using reader; how to move pages around in a pdf document
Chapter 27
API Reference
623
returned to a vendor for a full refund, but only withinalimited time after the
original purchase.
Arguments:
container—Indexofoneoftheplayer’sbagsorothercontainers(number,con-
tainerID)
slot—Indexofanitemslotwithinthecontainer(number,containerSlotID)
ConvertToRaid
Convertsaparty to araid.
Only haseffect if the player isina party andthe party leader.
CreateFont
Createsa new Font object.
fontObject= CreateFont(“name“)
Arguments:
name—Nametoassigntothenewlycreatedobject;usedbothasthenameof
the object (retrievable withFont:GetName()) andasa global variable referenc-
ing the object (unlessanother global by that name already exists) (string)
Returns:
fontObject—ThenewlycreatedFontobject(table)
CreateFrame
Createsa new Frame object.
frame= CreateFrame(“frameType“ [,“name“ [, parent[,“template“]]])
Arguments:
frameType—Typeofframetocreate;seethewidgetdocumentationfordetails
(string)
name(optional)—Nametoassigntothenewlycreatedobject;usedbothas
the name of the object (retrievable via the GetName method) and asa global
variable referencing the object, unless another global by that name already exists
(string)
parent(optional)—Referencetoanotherframetobethenewframe’sparent
(table)
template(optional)—Nameofatemplatetobeusedincreatingtheframe;
if creating a frame from multiple templates, a comma-separated list of names
(string)
Returns:
frame—AreferencetothenewlycreatedFrame(table)
Example:
--creates agenericbutton in the middleofthescreen
mybutton= CreateFrame(“Button“,“mybutton“,UIParent,i
“UIPanelButtonTemplate“)
mybutton:SetPoint(“CENTER“,0,0)
mybutton:SetWidth(80)
mybutton:SetHeight(22)
VB.NET PowerPoint: Sort and Reorder PowerPoint Slides by Using VB.
page will teach you to rearrange and readjust amount of robust PPT slides/pages editing methods and powerful & profession imaging controls, PDF document, image
reorder pages in pdf preview; pdf reorder pages
624
Part IV
Reference
CreateMacro
Creates anewmacro.
index= CreateMacro(“name“, icon, “body“, perCharacter)
Arguments:
name—Nameforthenewmacro(upto16characters);neednotbeunique,
thoughduplicate namescan cause issues forother MacroAPIfunctions(string)
icon—Indexofamacroicon(between1and GetNumMacroIcons())(number)
body—Bodyofthemacro(upto255characters)(string)
perCharacter1ifthemacroshouldbestoredasacharacter-specificmacro;
otherwisenil (1nil)
Returns:
index—Indexofthenewlycreatedmacro(number,macroID)
Example:
-- Createa characterspecific macro
localindex= CreateMacro(“DanceMonkey“,13, “/emote danceslike ai
monkey!!!“,1)
-- Createa general macro
localindex= CreateMacro(“Heal“, 73,“/cast Flash Heal\n/say Leti
thelightofElunecleanseyou!“)
CursorCanGoInSlot
Returns whether the item on the cursor canbe equipped inan inventory slot.
canBePlaced= CursorCanGoInSlot(slot)
Returnsnil if the cursor isempty or contains something other than an item.
Arguments:
slot—Aninventoryslotnumber,ascanbeobtainedfromGetInventory
SlotInfo(number,inventoryID)
Returns:
canBePlaced1iftheitemonthecursorcanbeequippedinthegivenslot;oth-
erwisenil (1nil)
CursorHasItem
Returns whether anitem is onthe cursor.
hasItem =CursorHasItem()
SeeGetCursorInfo() for more detailedinformation.
Returns:
hasItem1ifthecursoriscurrentlyholdinganitem;otherwise nil(1nil)
CursorHasMacro
Returns whether amacro ison the cursor.
hasMacro= CursorHasMacro()
SeeGetCursorInfo() for more detailedinformation.
Chapter 27
API Reference
625
Returns:
hasMacro1ifthecursoriscurrentlyholdingamacro;otherwise nil(1nil)
CursorHasMoney
Returnswhether an amount of the player’s money ison the cursor.
hasMoney= CursorHasMoney()
Returnsnil if the cursor holdsguild bank money. SeeGetCursorInfo() for
more detailed information.
Returns:
hasMoney1ifthecursoriscurrentlyholdinganamountoftheplayer’smoney;
otherwise nil (1nil)
CursorHasSpell
Returnswhether aspell is onthe cursor.
hasSpell= CursorHasSpell()
SeeGetCursorInfo() for more detailed information.
Returns:
hasSpell1ifthecursoriscurrentlyholdingaspell;otherwise nil(1nil)
DeclineArenaTeam
Declines an arena team invitation.
DeclineGroup
Declines an invitation to joina party or raid.
Usable in response to thePARTY_INVITE_REQUEST event whichfires whenthe
player isinvited to joina group.
DeclineGuild
Declines an offered guildinvitation.
Usable in response to theGUILD_INVITE_REQUEST event whichfires whenthe
player isinvited to joina guild.
DeclineInvite
Declines an invitationto a chat channel.
DeclineInvite(“channel“)
Usable in response to theCHANNEL_INVITE_REQUEST event which fires when
the player is invited to join achat channel.
Arguments:
channel—Nameofachatchannel(string)
DeclineLFGMatch
Declines aproposed LFG match.
Usable after a group match has beenproposed to the player viathe
LFG_MATCH_REQUESTevent.
DeclineLevelGrant
Refusesa level offeredby the player’sRecruit-a-Friend partner.
626
Part IV
Reference
DeclineName
Returns suggesteddeclensions for aname.
genitive,dative,accusative, instrumental, prepositional =i
DeclineName(“name“,gender,declensionSet)
In the Russian language, nouns (including proper names) take different form
based on their usage in asentence. Whenthe player entersthe base name for a
character or pet, the game suggests one or more setsof variations for the five
additional cases; the player isasked to choose from among the suggestions
and/or enter their own. (The set of declensions ultimately chosen/entered by
the player are only used internally and not available to addons.)
Hasno effect in non-Russian-localized clients.
Arguments:
name—Nominativeformoftheplayer’sorpet’sname(string)
gender—Genderforthereturnednames(fordeclensionsoftheplayer’sname,
should matchthe player’sgender; for the pet’sname, should be neuter) (number)
1or nil—Neuter
2—Male
3—Female
declensionSet—Indexofasetofsuggesteddeclensions(between
1and GetNumDeclensionSets(name,gender).Lowerindices
correspond to ‘‘better’’ suggestions for the given name. (number)
Returns:
genitive—Genitiveformofthename(string)
dative—Dativeformofthename(string)
accusative—Accusativeformofthename(string)
instrumental—Instrumentalformofthename(string)
prepositional—Prepositionalformofthename(string)
DeclineQuest
Declines aquest.
Usable following theQUEST_DETAIL event inwhich the questgiver presents
the player withthe details of a quest andthe option to accept or decline.
DeclineResurrect
Declines anofferedresurrectionspell.
Usable following theRESURRECT_REQUEST event which fires whenthe player
isoffered resurrection by another unit.
DelIgnore
Removesa player from the ignore list.
DelIgnore(“name“)
Arguments:
name—Nameofacharactertoremovefromtheignorelist(string)
Chapter 27
API Reference
627
DelMute
Removesa character from the muted list for voice chat.
DelMute(“name“)
The Muted list actsfor voice chat as the Ignore list doesfor text chat: muted
characterswill never be heard regardless of which voice channelsthey join the
player in.
Arguments:
name—Nameofacharactertoremovefromthemutelist(string)
Confirmation
DeleteCursorItem
Destroys the item onthe cursor.
Used inthe default UIwhenaccepting the confirmation prompt that appears
when dragging and dropping anitem to anempty areaof the screen.
Confirmation
DeleteEquipmentSet
Deletesanequipment set.
DeleteEquipmentSet(“name“)
Arguments:
name—Nameofanequipmentset(casesensitive)(string)
Confirmation
DeleteGMTicket
Abandonsthe currently pending GM ticket.
Confirmation
DeleteInboxItem
Deletesa message from the player’s inbox.
DeleteInboxItem(mailID)
Arguments:
mailID—Indexofamessageintheplayer’sinbox(between1and
GetInboxNumItems())(number)
DeleteMacro
Deletesa macro.
DeleteMacro(index)orDeleteMacro(“name“)
Arguments:
index—Indexofamacro(number,macroID)
name—Nameofamacro(string)
DemoteAssistant
Demotes the given player from raid assistant status.
DemoteAssistant(“unit“) or DemoteAssistant(“name“[,exactMatch])
Arguments:
unit—Aunitintheraid(string,unitID)
name—Nameofaunitintheraid(string)
exactMatch(optional)— Truetocheckonlyunitswhosenameexactly
matches thename given;false to allow partial matches (boolean)
628
Part IV
Reference
Confirmation
DepositGuildBankMoney
Deposits money into the guild bank.
DepositGuildBankMoney(money)
Arguments:
money—Amountofmoneytodeposit(incopper)(number)
Protected
DescendStop
Stops movement initiatedbySitStandOrDescendStart.
Used by theSITORSTAND binding, whichalso controls descent when
swimming or flying. Hasno meaningfuleffect if called while sitting/standing.
DestroyTotem
Destroys aspecific totem (or ghoul).
DestroyTotem(slot)
Totem functionsare also used for ghoulssummoned by aDeathKnight’s Raise
Dead ability (if the ghoul isnot made a controllable pet by the Master of
Ghouls talent).
Arguments:
slot—Whichtotemtodestroy(number)
1—Fire(orDeathKnight’sghoul)
2—Earth
3—Water
4—Air
DetectWowMouse
Detectsthe presence of a WoW-compatible multi-button mouse.
Thisfunctionisused by the default user interface to enable or disable the
configuration optionfor a many-buttoned WoW mouse. If the mouse isnot
found, theWOW_MOUSE_NOT_FOUND event will fire.
DisableAddOn
Marks anaddon asdisabled.
DisableAddOn(“name“) or DisableAddOn(index)
The addonwill remain active untilthe player logs out and back inor reloads
the UI (seeReloadUI()). Changesto the enabled/disabledstate of addons
while in-game are savedon aper-character basis.
Arguments:
name—Nameofanaddon(nameoftheaddon’sfolderandTOCfile,nottheTitle
found in the TOC) (string)
index—Indexofanaddonintheaddonlist(between1and GetNumAddOns())
(number)
DisableAllAddOns
Marks alladdons as disabled.
Addons will remainactive until the player logsout and back in or reloadsthe
UI(seeReloadUI()).
Documents you may be interested
Documents you may be interested