WoW:API GetTotemInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(New page: {{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> Returns information about totems <!-- List return values and argum...)
 
m (Move page script moved page API GetTotemInfo to API GetTotemInfo without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 6: Line 6:


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  arg1, totemName, startTime, duration = GetTotemInfo(1 through 4)
  haveTotem, totemName, startTime, duration = GetTotemInfo(1 through 4)




Line 15: Line 15:
:(integer)
:(integer)


:;integer: integer - index of the totem (fire=1 earth=2 water=3 air=4)
:;integer: integer - index of the totem (Fire = 1 Earth = 2 Water = 3 Air = 4)


=== Returns ===
=== Returns ===
<!-- List each return value, together with its type -->
<!-- List each return value, together with its type -->


:;arg1: seems to always return true.
:;haveTotem: returns true if you have the totem reagent in your bag ({{Loot|Common|Earth Totem}}, {{Loot|Common|Fire Totem}}, {{Loot|Common|Water Totem}}, {{Loot|Common|Air Totem}}).


:;totemName: returns the name of the currently active totem.
:;totemName: returns the name of the currently active totem.  If there is no active totem for this slot, this value will apparently be an empty string ("") instead of nil.


:;totemName: returns the GetTime() value of when the totem started.
:;startTime: returns the GetTime() value of when the totem started.


:;duration: returns the duraiton (in seconds) of the currently active totem.
:;duration: returns the duraiton (in seconds) of the currently active totem.
Line 45: Line 45:




Yeah, umm this is my first time making a page, so feel free to fix it up. --xkq
GetTotemTimeLeft(slot): global function returns active time remaining (in seconds) for a totem in a given slot.

Latest revision as of 04:46, 15 August 2023

← WoW API < GetTotemInfo


Returns information about totems 

haveTotem, totemName, startTime, duration = GetTotemInfo(1 through 4)


Parameters[edit]

Arguments[edit]

(integer)
integer
integer - index of the totem (Fire = 1 Earth = 2 Water = 3 Air = 4)

Returns[edit]

haveTotem
returns true if you have the totem reagent in your bag (Template:Loot, Template:Loot, Template:Loot, Template:Loot).
totemName
returns the name of the currently active totem. If there is no active totem for this slot, this value will apparently be an empty string ("") instead of nil.
startTime
returns the GetTime() value of when the totem started.
duration
returns the duraiton (in seconds) of the currently active totem.


Example

Displays the duration of all active totems 

for index=1,4 do
  local arg1, totemName, startTime, duration = GetTotemInfo(index)
  local est_dur = round(startTime+duration-GetTime() )
  DEFAULT_CHAT_FRAME:AddMessage(totemName .. "  " .. est_dur)  
end

Details[edit]

GetTotemTimeLeft(slot): global function returns active time remaining (in seconds) for a totem in a given slot.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetTotemInfo&oldid=19335"