WoW:API GetNumCompanions - Revision history

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

2023-08-15T04:46:11Z

Move page script moved page API GetNumCompanions to API GetNumCompanions without leaving a redirect

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

WoWWiki>Starlightblunder: cleanup

2010-06-05T23:42:08Z

cleanup

← Older revision		Revision as of 23:42, 5 June 2010
Line 1:		Line 1:
	{{wowapi}} ~~__NOTOC__~~		{{wowapi}}


	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~
	Returns the number of companions you have. New in [[Patch 3.0]]		Returns the number of companions you have. New in [[Patch 3.0]]

	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	count = GetNumCompanions("type")		count = GetNumCompanions("type")

			== Arguments ==
			;type : String ([[companionType]]) - Type of companions to count ("CRITTER", or "MOUNT")

	~~== Parameters ==~~		== Returns ==
	~~=== Arguments ===~~		;count : Number - The number of companions of a specific type.
	~~<!-- List each argument, together with its type -->~~
	~~:("type")~~

	~~:;type : String - The [[API TYPE TypeId\|TypeID]] to query (e.g. "CRITTER", or "MOUNT")~~

	=== Returns ===
	~~<!-- List each return value, together with its type -->~~
	:;count : ~~Integer~~ - The number of companions of a specific type.

	== Example ==		== Example ==
	<!-~~- If it helps, include an example here, though it's not required if~~ the ~~usage is self-explanatory -->~~		The following snippet prints how many mini-pets the player has collected.
	~~<!-- begin code -->~~
	local count = GetNumCompanions("CRITTER");		local count = GetNumCompanions("CRITTER");
	~~ChatFrame1:AddMessage~~('Hello, I have collected a total of ' .. count .. ' pets.');		print('Hello, I have collected a total of ' .. count .. ' pets.');
	~~<!-- end code -->~~

	~~====Result====~~
	~~<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->~~
	~~:Prints how many mini-pets the player has collected. e.g.~~
	~~<!-- begin code -->~~
	~~Hello, I have collected a total of 34 pets.~~
	~~<!-- end code -->~~
	~~[[Category:World of Warcraft API]]~~

WoWWiki>Phyber: /* Result */ fix typo.

2009-04-07T09:20:26Z

Result: fix typo.

← Older revision		Revision as of 09:20, 7 April 2009
Line 29:		Line 29:
	====Result====		====Result====
	<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->		<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
	:Prints how many mini-pets the player has ~~coollected~~. e.g.		:Prints how many mini-pets the player has collected. e.g.
	<!-- begin code -->		<!-- begin code -->
	Hello, I have collected a total of 34 pets.		Hello, I have collected a total of 34 pets.
	<!-- end code -->		<!-- end code -->

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Ackis: Initial creation

2008-08-02T07:14:14Z

Initial creation

New page

{{wowapi}} __NOTOC__


Returns the number of companions you have. New in [[Patch 3.0]]


count = GetNumCompanions("type")

== Parameters ==
=== Arguments ===

:("type")

:;type : String - The [[API TYPE TypeId|TypeID]] to query (e.g. "CRITTER", or "MOUNT")

=== Returns ===

:;count : Integer - The number of companions of a specific type.

== Example ==


local count = GetNumCompanions("CRITTER");
ChatFrame1:AddMessage('Hello, I have collected a total of ' .. count .. ' pets.');


====Result====

:Prints how many mini-pets the player has coollected. e.g.

Hello, I have collected a total of 34 pets.


[[Category:World of Warcraft API]]