SessionGoldTracker/docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua

local PetInfo =
{
	Name = "PetInfo",
	Type = "System",
	Namespace = "C_PetInfo",
	Environment = "All",

	Functions =
	{
		{
			Name = "CanPetEatItem",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "itemID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "canEat", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "GetPetFoodTypes",
			Type = "Function",

			Returns =
			{
				{ Name = "foodTypes", Type = "table", InnerType = "string", Nilable = false },
			},
		},
		{
			Name = "GetPetHappiness",
			Type = "Function",
			MayReturnNothing = true,

			Returns =
			{
				{ Name = "happiness", Type = "number", Nilable = false },
				{ Name = "damagePercentage", Type = "number", Nilable = false },
				{ Name = "loyaltyRate", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetPetLoyalty",
			Type = "Function",
			MayReturnNothing = true,

			Returns =
			{
				{ Name = "loyaltyName", Type = "string", Nilable = false },
			},
		},
		{
			Name = "GetPetTalentTree",
			Type = "Function",
			MayReturnNothing = true,

			Returns =
			{
				{ Name = "talentTreeName", Type = "stringView", Nilable = false },
			},
		},
		{
			Name = "GetPetTamersForMap",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "uiMapID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "petTamers", Type = "table", InnerType = "PetTamerMapInfo", Nilable = false },
			},
		},
		{
			Name = "GetPetTrainingPoints",
			Type = "Function",

			Returns =
			{
				{ Name = "totalPoints", Type = "number", Nilable = false },
				{ Name = "usedPoints", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetPetUIModelSceneID",
			Type = "Function",

			Returns =
			{
				{ Name = "modelSceneID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetSpellForPetAction",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "actionID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "spellID", Type = "number", Nilable = true },
			},
		},
		{
			Name = "IsPetActionPassive",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "actionID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "isPassive", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "PetAbandon",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "petNumber", Type = "number", Nilable = true },
			},
		},
		{
			Name = "PetAssistMode",
			Type = "Function",
		},
		{
			Name = "PetRename",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "name", Type = "cstring", Nilable = false },
				{ Name = "petNumber", Type = "number", Nilable = true },
				{ Name = "declensions", Type = "table", InnerType = "cstring", Nilable = true },
			},
		},
	},

	Events =
	{
		{
			Name = "PetAttackStart",
			Type = "Event",
			LiteralName = "PET_ATTACK_START",
			SynchronousEvent = true,
		},
		{
			Name = "PetAttackStop",
			Type = "Event",
			LiteralName = "PET_ATTACK_STOP",
			SynchronousEvent = true,
		},
		{
			Name = "PetBarHidegrid",
			Type = "Event",
			LiteralName = "PET_BAR_HIDEGRID",
			SynchronousEvent = true,
		},
		{
			Name = "PetBarShowgrid",
			Type = "Event",
			LiteralName = "PET_BAR_SHOWGRID",
			SynchronousEvent = true,
		},
		{
			Name = "PetBarUpdateCooldown",
			Type = "Event",
			LiteralName = "PET_BAR_UPDATE_COOLDOWN",
			SynchronousEvent = true,
		},
		{
			Name = "PetDismissStart",
			Type = "Event",
			LiteralName = "PET_DISMISS_START",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "delay", Type = "number", Nilable = false },
			},
		},
		{
			Name = "PetForceNameDeclension",
			Type = "Event",
			LiteralName = "PET_FORCE_NAME_DECLENSION",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "name", Type = "cstring", Nilable = false },
				{ Name = "petNumber", Type = "number", Nilable = true },
				{ Name = "declinedName1", Type = "cstring", Nilable = true },
				{ Name = "declinedName2", Type = "cstring", Nilable = true },
				{ Name = "declinedName3", Type = "cstring", Nilable = true },
				{ Name = "declinedName4", Type = "cstring", Nilable = true },
				{ Name = "declinedName5", Type = "cstring", Nilable = true },
			},
		},
		{
			Name = "PetUiClose",
			Type = "Event",
			LiteralName = "PET_UI_CLOSE",
			SynchronousEvent = true,
		},
		{
			Name = "RaisedAsGhoul",
			Type = "Event",
			LiteralName = "RAISED_AS_GHOUL",
			SynchronousEvent = true,
		},
		{
			Name = "UpdatePossessBar",
			Type = "Event",
			LiteralName = "UPDATE_POSSESS_BAR",
			SynchronousEvent = true,
		},
		{
			Name = "UpdateVehicleActionbar",
			Type = "Event",
			LiteralName = "UPDATE_VEHICLE_ACTIONBAR",
			SynchronousEvent = true,
		},
	},

	Tables =
	{
		{
			Name = "PetTamerMapInfo",
			Type = "Structure",
			Fields =
			{
				{ Name = "areaPoiID", Type = "number", Nilable = false },
				{ Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false },
				{ Name = "name", Type = "cstring", Nilable = false },
				{ Name = "atlasName", Type = "string", Nilable = true },
				{ Name = "textureIndex", Type = "number", Nilable = true },
			},
		},
	},

	Predicates =
	{
	},
};

APIDocumentation:AddDocumentationTable(PetInfo);