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

local PlayerInfo =
{
	Name = "PlayerInfo",
	Type = "System",
	Namespace = "C_PlayerInfo",
	Environment = "All",

	Functions =
	{
		{
			Name = "CanPlayerEnterChromieTime",
			Type = "Function",

			Returns =
			{
				{ Name = "canEnter", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "CanPlayerUseAreaLoot",
			Type = "Function",

			Returns =
			{
				{ Name = "canUseAreaLoot", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "CanPlayerUseMountEquipment",
			Type = "Function",

			Returns =
			{
				{ Name = "canUseMountEquipment", Type = "bool", Nilable = false },
				{ Name = "failureReason", Type = "string", Nilable = false },
			},
		},
		{
			Name = "CanUseItem",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "isUseable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "GetAlternateFormInfo",
			Type = "Function",

			Returns =
			{
				{ Name = "hasAlternateForm", Type = "bool", Nilable = false },
				{ Name = "inAlternateForm", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "GetContentDifficultyCreatureForPlayer",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "unitToken", Type = "UnitToken", Nilable = false },
			},

			Returns =
			{
				{ Name = "difficulty", Type = "RelativeContentDifficulty", Nilable = false },
			},
		},
		{
			Name = "GetContentDifficultyQuestForPlayer",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "difficulty", Type = "RelativeContentDifficulty", Nilable = false },
			},
		},
		{
			Name = "GetDisplayID",
			Type = "Function",

			Returns =
			{
				{ Name = "displayID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetGlidingInfo",
			Type = "Function",

			Returns =
			{
				{ Name = "isGliding", Type = "bool", Nilable = false },
				{ Name = "canGlide", Type = "bool", Nilable = false },
				{ Name = "forwardSpeed", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetInstancesUnlockedAtLevel",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "level", Type = "number", Nilable = false },
				{ Name = "isRaid", Type = "bool", Nilable = false },
			},

			Returns =
			{
				{ Name = "dungeonID", Type = "table", InnerType = "number", Nilable = false },
			},
		},
		{
			Name = "GetNativeDisplayID",
			Type = "Function",

			Returns =
			{
				{ Name = "nativeDisplayID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetPetStableCreatureDisplayInfoID",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "creatureDisplayInfoID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetPlayerCharacterData",
			Type = "Function",
			MayReturnNothing = true,

			Returns =
			{
				{ Name = "characterData", Type = "PlayerInfoCharacterData", Nilable = false },
			},
		},
		{
			Name = "GetPlayerMythicPlusRatingSummary",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",
			Documentation = { "Returns the players mythic+ rating summary which includes the runs they've completed as well as their current season m+ rating" },

			Arguments =
			{
				{ Name = "playerToken", Type = "UnitToken", Nilable = false },
			},

			Returns =
			{
				{ Name = "ratingSummary", Type = "MythicPlusRatingSummary", Nilable = false },
			},
		},
		{
			Name = "HasAccountInventoryLock",
			Type = "Function",

			Returns =
			{
				{ Name = "hasAccountInventoryLock", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "HasVisibleInvSlot",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "slot", Type = "luaIndex", Nilable = false },
			},

			Returns =
			{
				{ Name = "isVisible", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsAccountBankEnabled",
			Type = "Function",

			Returns =
			{
				{ Name = "isAccountBankEnabled", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsCharacterBankEnabled",
			Type = "Function",

			Returns =
			{
				{ Name = "isCharacterBankEnabled", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsDisplayRaceNative",
			Type = "Function",

			Returns =
			{
				{ Name = "isDisplayRaceNative", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsExpansionLandingPageUnlockedForPlayer",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "isUnlocked", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsMirrorImage",
			Type = "Function",

			Returns =
			{
				{ Name = "isMirrorImage", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsPlayerEligibleForNPE",
			Type = "Function",

			Returns =
			{
				{ Name = "isEligible", Type = "bool", Nilable = false },
				{ Name = "failureReason", Type = "string", Nilable = false },
			},
		},
		{
			Name = "IsPlayerEligibleForNPEv2",
			Type = "Function",

			Returns =
			{
				{ Name = "isEligible", Type = "bool", Nilable = false },
				{ Name = "failureReason", Type = "string", Nilable = false },
			},
		},
		{
			Name = "IsPlayerInChromieTime",
			Type = "Function",

			Returns =
			{
				{ Name = "inChromieTime", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsPlayerInRPE",
			Type = "Function",

			Returns =
			{
				{ Name = "isInRPE", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsPlayerInTimerunningHeroicWorldTier",
			Type = "Function",

			Returns =
			{
				{ Name = "inTimerunningHeroicWorldTier", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsPlayerNPERestricted",
			Type = "Function",

			Returns =
			{
				{ Name = "isRestricted", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsReturningCharacter",
			Type = "Function",

			Returns =
			{
				{ Name = "isReturning", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsSelfFoundActive",
			Type = "Function",

			Returns =
			{
				{ Name = "active", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsTradingPostAvailable",
			Type = "Function",

			Returns =
			{
				{ Name = "isAvailable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsTravelersLogAvailable",
			Type = "Function",

			Returns =
			{
				{ Name = "isAvailable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsTutorialsTabAvailable",
			Type = "Function",

			Returns =
			{
				{ Name = "isAvailable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "ShouldDisplaySurname",
			Type = "Function",

			Returns =
			{
				{ Name = "display", Type = "bool", Nilable = false },
			},
		},
	},

	Events =
	{
	},

	Tables =
	{
		{
			Name = "MythicPlusRatingMapSummary",
			Type = "Structure",
			Documentation = { "Specific information about a completed mythic plus run." },
			Fields =
			{
				{ Name = "challengeModeID", Type = "number", Nilable = false },
				{ Name = "mapScore", Type = "number", Nilable = false },
				{ Name = "bestRunLevel", Type = "number", Nilable = false },
				{ Name = "bestRunDurationMS", Type = "number", Nilable = false },
				{ Name = "finishedSuccess", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "MythicPlusRatingSummary",
			Type = "Structure",
			Documentation = { "The current season rating and well as a list of completed mythic plus runs." },
			Fields =
			{
				{ Name = "currentSeasonScore", Type = "number", Nilable = false },
				{ Name = "runs", Type = "table", InnerType = "MythicPlusRatingMapSummary", Nilable = false },
			},
		},
	},

	Predicates =
	{
	},
};

APIDocumentation:AddDocumentationTable(PlayerInfo);