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

local ContentTracking =
{
	Name = "ContentTracking",
	Type = "System",
	Namespace = "C_ContentTracking",
	Environment = "All",

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

			Arguments =
			{
				{ Name = "trackableType", Type = "ContentTrackingType", Nilable = false },
				{ Name = "trackableID", Type = "number", Nilable = false },
				{ Name = "ignoreWaypoint", Type = "bool", Nilable = false, Default = false },
			},

			Returns =
			{
				{ Name = "result", Type = "ContentTrackingResult", Nilable = false },
				{ Name = "mapID", Type = "number", Nilable = true },
			},
		},
		{
			Name = "GetCollectableSourceTrackingEnabled",
			Type = "Function",

			Returns =
			{
				{ Name = "isEnabled", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "GetCollectableSourceTypes",
			Type = "Function",

			Returns =
			{
				{ Name = "collectableSourceTypes", Type = "table", InnerType = "ContentTrackingType", Nilable = false },
			},
		},
		{
			Name = "GetCurrentTrackingTarget",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false },
				{ Name = "targetID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetEncounterTrackingInfo",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "trackingInfo", Type = "EncounterTrackingInfo", Nilable = false },
			},
		},
		{
			Name = "GetNextWaypointForTrackable",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "result", Type = "ContentTrackingResult", Nilable = false },
				{ Name = "mapInfo", Type = "ContentTrackingMapInfo", Nilable = true },
			},
		},
		{
			Name = "GetObjectiveText",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false },
				{ Name = "targetID", Type = "number", Nilable = false },
				{ Name = "includeHyperlinks", Type = "bool", Nilable = false, Default = true },
			},

			Returns =
			{
				{ Name = "objectiveText", Type = "string", Nilable = false },
			},
		},
		{
			Name = "GetTitle",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "trackableType", Type = "ContentTrackingType", Nilable = false },
				{ Name = "trackableID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "title", Type = "string", Nilable = false },
			},
		},
		{
			Name = "GetTrackablesOnMap",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "result", Type = "ContentTrackingResult", Nilable = false },
				{ Name = "trackableMapInfos", Type = "table", InnerType = "ContentTrackingMapInfo", Nilable = false },
			},
		},
		{
			Name = "GetTrackedIDs",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "trackableType", Type = "ContentTrackingType", Nilable = false },
			},

			Returns =
			{
				{ Name = "entryIDs", Type = "table", InnerType = "number", Nilable = false },
			},
		},
		{
			Name = "GetVendorTrackingInfo",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

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

			Returns =
			{
				{ Name = "vendorTrackingInfo", Type = "VendorTrackingInfo", Nilable = false },
			},
		},
		{
			Name = "GetWaypointText",
			Type = "Function",
			MayReturnNothing = true,
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "trackableType", Type = "ContentTrackingType", Nilable = false },
				{ Name = "trackableID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "waypointText", Type = "string", Nilable = false },
			},
		},
		{
			Name = "IsNavigable",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",
			Documentation = { "If successful, returns if the trackable is either on your current map, or if we're able to determine a route to that map from your location via waypoints." },

			Arguments =
			{
				{ Name = "trackableType", Type = "ContentTrackingType", Nilable = false },
				{ Name = "trackableID", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "result", Type = "ContentTrackingResult", Nilable = false },
				{ Name = "isNavigable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsTrackable",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "isTrackable", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "IsTracking",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "isTracking", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "StartTracking",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
			},

			Returns =
			{
				{ Name = "error", Type = "ContentTrackingError", Nilable = true },
			},
		},
		{
			Name = "StopTracking",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
				{ Name = "stopType", Type = "ContentTrackingStopType", Nilable = false },
			},
		},
		{
			Name = "ToggleTracking",
			Type = "Function",
			SecretArguments = "AllowedWhenUntainted",

			Arguments =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
				{ Name = "stopType", Type = "ContentTrackingStopType", Nilable = false },
			},

			Returns =
			{
				{ Name = "error", Type = "ContentTrackingError", Nilable = true },
			},
		},
	},

	Events =
	{
		{
			Name = "ContentTrackingIsEnabledUpdate",
			Type = "Event",
			LiteralName = "CONTENT_TRACKING_IS_ENABLED_UPDATE",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "isEnabled", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "ContentTrackingListUpdate",
			Type = "Event",
			LiteralName = "CONTENT_TRACKING_LIST_UPDATE",
			SynchronousEvent = true,
		},
		{
			Name = "ContentTrackingUpdate",
			Type = "Event",
			LiteralName = "CONTENT_TRACKING_UPDATE",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
				{ Name = "isTracked", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "TrackableInfoUpdate",
			Type = "Event",
			LiteralName = "TRACKABLE_INFO_UPDATE",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "type", Type = "ContentTrackingType", Nilable = false },
				{ Name = "id", Type = "number", Nilable = false },
			},
		},
		{
			Name = "TrackingTargetInfoUpdate",
			Type = "Event",
			LiteralName = "TRACKING_TARGET_INFO_UPDATE",
			SynchronousEvent = true,
			Payload =
			{
				{ Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false },
				{ Name = "targetID", Type = "number", Nilable = false },
			},
		},
	},

	Tables =
	{
	},

	Predicates =
	{
	},
};

APIDocumentation:AddDocumentationTable(ContentTracking);