WoW:API HasSoulstone: Difference between revisions

WoW:API HasSoulstone (source)

562 bytes added , 15 August 2023

m

Move page script moved page API HasSoulstone to WoW:API HasSoulstone without leaving a redirect

Anonymous user

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-Returns true if your character possess a soulstone.
+Returns whether or not, and how, your character can self-resurrect.
-  HasSoulstone();
+  text = HasSoulstone()
-----
-;''Arguments''
+==Parameters==
+===Arguments===
 :''none''
-----
+===Returns===
-;''Returns''
+:;text : string or nil - the type of self-resurrect available to your character (known values are "Use Soulstone", "Reincarnate", and "Twisting Nether") or nil if none are available
-:;Boolean
-----
-;''Example''
- if HasSoulstone() then
-   --do something
- end;
-;''Result''
+==Details==
-Returns true if your character possess a soulstone.
+* This function also returns nil if used while your character is alive.
+* The return values from this function are (presumably) localized.
+* The text returned by this function is used in the default Blizzard UI as part of the popup that appears when your character dies, to determine whether the second button should be shown, and if so, what text should be shown on it.
+* The "Twisting Nether" self-resurrection is a proc from the item [[Darkmoon_Card:_Twisting_Nether]].