clan goals

[Soap-0020]

Is your feature request related to a problem? Please describe.
Im anoyed figuring out what the clan goals mean

Describe the solution you'd like
A new api OR add onto the preexisting clan api to allow deeper understanding into what "type" and "tier" mean

[v1Pe04]

It's weird that these are not included anywhere in the api... I have had to cross reference the Type ids with the actual description in the game and have just resonated to caching them in my application... This shouldve definitively been included somewhere either in the clan endpoint or with another endpoint

[krystoxbox]

It's weird that these are not included anywhere in the api... I have had to cross reference the Type ids with the actual description in the game and have just resonated to caching them in my application... This shouldve definitively been included somewhere either in the clan endpoint or with another endpoint

@v1Pe04 can you send me this references? thanks in advance

[chickenputty]

These are pretty deep in the codebase. For now, here is a list that you can re-work for your needs:

local module = {
	Goals = { 
		BREAKABLE = 1,
		PET = 2,
		EGG = 3,
		GOLD_PET = 4,
		RAINBOW_PET = 5,
		ZONE = 6,
		CURRENCY = 7,
		
		-- these are all generic (take no further arguments)
		MINI_CHEST = 8, 
		DIAMOND_BREAKABLE = 9,
		BUY_POTION = 10, 
		BUY_ENCHANT = 11, 
		UPGRADE_POTION = 12, 
		UPGRADE_ENCHANT = 13, 
		COLLECT_POTION = 14,
		COLLECT_ENCHANT = 15,
		FREE_GIFT = 18, 
		
		FUSE_PETS = 19, 
		
		BEST_EGG = 20,
		CURRENT_BREAKABLE = 21,
		
		SPAWN_OBBY = 22, 
		MINEFIELD = 23,
		ATLANTIS = 24,
		DIGSITE = 25, -- Find chests
		FISHING = 26, -- Catch fish
		ICE_OBBY = 27,
		PYRAMID_OBBY = 28, 
		JUNGLE_OBBY = 29,
		CHEST_RUSH = 30,
		SLED_RACE = 36,
		CART_RIDE = 59,
		HOVERBOARD_OBBY = 60,
		DIAMOND_WHEEL = 61,
		
		USE_FLAG = 33,
		USE_POTION = 34,
		USE_FRUIT = 35,

		BEST_COIN_JAR = 37,
		BEST_COMET = 38,
		BEST_MINI_CHEST = 39,
		BEST_GOLD_PET = 40,
		BEST_RAINBOW_PET = 41,
		HATCH_RARE_PET = 42,
		BEST_PINATA = 43,
		BEST_LUCKYBLOCK = 44,
		ADVANCED_DIGSITE = 45,
		ADVANCED_FISHING = 46,
		
		INDEX_PET = 47,
		BLACK_LUCKY_BLOCK = 48,
		FISH_SHARD = 49,
		MAGIC_POOL = 50,
		SELL_AT_BOOTH = 51,
		TRADE_PLAYER = 52,
		FREE_GIFT_IN_TRADE = 53,
		FREE_GIFT_IN_MAIL = 54,
		USE_SECRET_KEY = 55,
		USE_CRYSTAL_KEY = 56,
		UPGRADE_FRUIT = 57,
		PLANT_GARDEN = 58,
		ITEM_CREATOR = 62,
		
		GET_CRITICAL = 63,
		COLLECT_LOOTBAG = 64,
		COLLECT_FRUIT = 65,

		COIN_JAR = 31,
		COMET = 32,
		PINATA = 66,
		LUCKYBLOCK = 67,

		RANDOM_COIN_JAR = 68,
		RANDOM_COMET = 69,
		RANDOM_PINATA = 70,
		RANDOM_LUCKYBLOCK = 71,
		RANDOM_MINI_CHEST = 72,
		
		HIDEOUT_BREAKABLE = 73,
		XP_POTION = 74,
		
	}
}

function module.MakeTitle(goal: (QuestTypes.active_goal_schema)): string 
	local _sh = Functions.NumberShorten
	local dif = goal.Amount - goal.Progress
	if goal.Type == QuestTypes.Goals.BREAKABLE then 
		if goal.BreakableType then
			return dif > 1 and `Break {_sh(dif)} {goal.BreakableType}s` or `Break 1 {goal.BreakableType}`
		else 
			return dif > 1 and `Break {_sh(dif)} breakables` or `Break something`
		end
	elseif goal.Type == QuestTypes.Goals.CURRENT_BREAKABLE then
		return dif > 1 and `Break {_sh(dif)} breakables in best area` or `Break something in best area`
	elseif goal.Type == QuestTypes.Goals.CURRENCY then 
		return `Earn {_sh(goal.Amount)} {goal.CurrencyID}`
	elseif goal.Type == QuestTypes.Goals.ZONE then 
		return dif > 1 and `Unlock {dif} zones` or "Unlock an area"	
	elseif goal.Type == QuestTypes.Goals.GOLD_PET then 
		return dif > 1 and `Make {dif} golden pets` or "Make a golden pet"
	elseif goal.Type == QuestTypes.Goals.BEST_GOLD_PET then 
		return dif > 1 and `Make {dif} golden pets from best egg` or "Make a golden pet from best egg"
	elseif goal.Type == QuestTypes.Goals.RAINBOW_PET then 
		return dif > 1 and `Make {dif} rainbow pets` or "Make a rainbow pet"
	elseif goal.Type == QuestTypes.Goals.BEST_RAINBOW_PET then 
		return dif > 1 and `Make {dif} rainbow pets from best egg` or "Make a rainbow pet from best egg"
	elseif goal.Type == QuestTypes.Goals.EGG then 
		if goal.EggID then 
			local dir = Directory.Eggs[goal.EggID]
			if not dir then
				warn("BAD EGG ID", goal.EggID)
			end
			return dif > 1 and `Hatch {dif} egg {dir.eggNumber}` or `Hatch egg {dir.eggNumber}`
		else 
			return dif > 1 and `Hatch {dif} eggs` or `Hatch an egg`
		end
	elseif goal.Type == QuestTypes.Goals.BEST_EGG then
		local save = Save.Get()
		assert(save)
		return dif > 1 and `Hatch {dif} of your best eggs` or `Hatch one of your best eggs`
	elseif goal.Type == QuestTypes.Goals.PET then 
		if goal.PetID then 
			local dir = Directory.Pets[goal.PetID]
			return goal.Amount > 1 and `Hatch {dif} {dir.name}s` or `Hatch a {dir.name}`
		else 
			return dif > 1 and `Hatch {dif} pets` or `Hatch a pet`
		end
	elseif goal.Type == QuestTypes.Goals.HATCH_RARE_PET then 
		return dif > 1 and `Hatch {dif} rare \"??\" pets` or `Hatch a rare \"??\" pet`
	elseif goal.Type == QuestTypes.Goals.USE_FRUIT then
		if goal.FruitID then 
			local dir = Directory.Fruits[goal.FruitID]
			return goal.Amount > 1 and `Use {dif} {dir.DisplayName}` or `Use a {dir.DisplayName}`
		else 
			return dif > 1 and `Use {dif} fruits` or `Use a fruit`
		end
	elseif goal.Type == QuestTypes.Goals.USE_POTION then
		local tierRequired = goal.PotionTier ~= nil and RomanNum(goal.PotionTier) or nil
		local tierString = tierRequired ~= nil and "Tier " .. tierRequired .. " " or ""
		if goal.PotionID then 
			local dir = Directory.Potions[goal.PotionID]
			return goal.Amount > 1 and `Use {dif} {dir.DisplayName(goal.PotionTier)}` or `Use a {dir.DisplayName(goal.PotionTier)}`
		else 
			return dif > 1 and `Use {dif} {tierString}Potions` or `Use a {tierString}Potion`
		end
	elseif goal.Type == QuestTypes.Goals.UPGRADE_POTION then
		local tierRequired = goal.PotionTier ~= nil and RomanNum(goal.PotionTier) or nil
		local tierString = tierRequired ~= nil and "Tier " .. tierRequired .. " " or ""
		if goal.PotionID then 
			local dir = Directory.Potions[goal.PotionID]
			return goal.Amount > 1 and `Upgrade to {dif} {dir.DisplayName(goal.PotionTier)}` or `Upgrade to a {dir.DisplayName(goal.PotionTier)}`
		else 
			return dif > 1 and `Upgrade to {dif} {tierString}Potions` or `Upgrade to a {tierString}Potion`
		end
	elseif goal.Type == QuestTypes.Goals.UPGRADE_ENCHANT then
		local tierRequired = goal.EnchantTier ~= nil and RomanNum(goal.EnchantTier) or nil
		local tierString = tierRequired ~= nil and "Tier " .. tierRequired .. " " or ""
		if goal.EnchantID then 
			local dir = Directory.Potions[goal.EnchantID]
			return goal.Amount > 1 and `Upgrade to {dif} {dir.DisplayName(goal.EnchantTier)}` or `Upgrade to a {dir.DisplayName(goal.EnchantTier)}`
		else 
			return dif > 1 and `Upgrade to {dif} {tierString}Enchants` or `Upgrade to a {tierString}Enchant`
		end
	elseif goal.Type == QuestTypes.Goals.MINI_CHEST then 
		return dif > 1 and `Break {dif} mini-chests` or `Break a mini-chest`
	elseif goal.Type == QuestTypes.Goals.COIN_JAR then 
		return dif > 1 and `Break {dif} coin jars` or `Break a coin jar`
	elseif goal.Type == QuestTypes.Goals.COMET then 
		return dif > 1 and `Break {dif} comets` or `Break a comet`
		

	elseif goal.Type == QuestTypes.Goals.RANDOM_MINI_CHEST then 
		return dif > 1 and `Break {dif} randomly spawned mini-chests` or `Break a randomly spawned mini-chest`
	elseif goal.Type == QuestTypes.Goals.RANDOM_COIN_JAR then 
		return dif > 1 and `Break {dif} randomly spawned coin jars` or `Break a randomly spawned coin jar`
	elseif goal.Type == QuestTypes.Goals.RANDOM_COMET then 
		return dif > 1 and `Break {dif} randomly spawned comets` or `Break a randomly spawned comet`
	elseif goal.Type == QuestTypes.Goals.RANDOM_PINATA then 
		return dif > 1 and `Break {dif} randomly spawned pinatas` or `Break a randomly spawned pinata`
	elseif goal.Type == QuestTypes.Goals.RANDOM_LUCKYBLOCK then 
		return dif > 1 and `Break {dif} randomly spawned lucky block event` or `Break a randomly spawned lucky block event`
		
	elseif goal.Type == QuestTypes.Goals.BEST_MINI_CHEST then 
		return dif > 1 and `Break {dif} mini-chests in best area` or `Break a mini-chest in best area`
	elseif goal.Type == QuestTypes.Goals.BEST_COIN_JAR then 
		return dif > 1 and `Break {dif} coin jars in best area` or `Break a coin jar in best area`
	elseif goal.Type == QuestTypes.Goals.BEST_COMET then 
		return dif > 1 and `Break {dif} comets in best area` or `Break a comet in best area`
	elseif goal.Type == QuestTypes.Goals.BEST_PINATA then 
		return dif > 1 and `Break {dif} pinatas in best area` or `Break a pinata in best area`
	elseif goal.Type == QuestTypes.Goals.BEST_LUCKYBLOCK then 
		return dif > 1 and `Break {dif} lucky block event in best area` or `Break a lucky block event in best area`
	elseif goal.Type == QuestTypes.Goals.PINATA then 
		return dif > 1 and `Break {dif} pinatas in best area` or `Break a pinata in best area`
	elseif goal.Type == QuestTypes.Goals.LUCKYBLOCK then 
		return dif > 1 and `Break {dif} lucky block event` or `Break a lucky block event`
	elseif goal.Type == QuestTypes.Goals.USE_FLAG then 
		return dif > 1 and `Use {dif} flags` or `Use a flag`
	elseif goal.Type == QuestTypes.Goals.DIAMOND_BREAKABLE then 
		return `Break {dif} diamond breakables`
	elseif goal.Type == QuestTypes.Goals.BUY_POTION then 
		return dif > 1 and `Purchase {_sh(dif)} potions` or "Purchase a potion"
	elseif goal.Type == QuestTypes.Goals.BUY_ENCHANT then 
		return dif > 1 and `Purchase {_sh(dif)} enchants` or "Purchse an enchant"
	elseif goal.Type == QuestTypes.Goals.COLLECT_POTION then 
		return dif > 1 and `Collect {_sh(dif)} potions` or "Collect a potion"
	elseif goal.Type == QuestTypes.Goals.COLLECT_ENCHANT then 
		return dif > 1 and `Collect {_sh(dif)} enchants` or "Collect an enchant"
	elseif goal.Type == QuestTypes.Goals.COLLECT_FRUIT then 
		return dif > 1 and `Collect {_sh(dif)} fruits` or "Collect a fruit"
	elseif goal.Type == QuestTypes.Goals.UPGRADE_POTION then 
		return dif > 1 and `Upgrade {_sh(dif)} potions` or "Upgrade a potion"
	elseif goal.Type == QuestTypes.Goals.UPGRADE_ENCHANT then
		return dif > 1 and `Upgrade {_sh(dif)} enchants` or "Upgrade an enchant"
	elseif goal.Type == QuestTypes.Goals.FREE_GIFT then 
		return dif > 1 and `Redeem {_sh(dif)} free gifts` or "Redeem a free gift"
	elseif goal.Type == QuestTypes.Goals.FUSE_PETS then 
		return dif > 1 and `Fuse {_sh(dif)} pets` or "Fuse a pet"
	elseif goal.Type == QuestTypes.Goals.SPAWN_OBBY then 
		return dif > 1 and `Complete the Classic Obby (x{_sh(dif)})` or "Complete the Classic Obby"
	elseif goal.Type == QuestTypes.Goals.MINEFIELD then 
		return dif > 1 and `Complete the Minefield (x{_sh(dif)})` or "Complete the Minefield"
	elseif goal.Type == QuestTypes.Goals.ATLANTIS then 
		return dif > 1 and `Complete the Atlantis Minigame (x{_sh(dif)})` or "Complete the Atlantis Minigame"
	elseif goal.Type == QuestTypes.Goals.DIGSITE then 
		return dif > 1 and `Find (x{_sh(dif)}) chests in the Digsite` or "Find a chest in the Digsite"
	elseif goal.Type == QuestTypes.Goals.ADVANCED_DIGSITE then 
		return dif > 1 and `Find (x{_sh(dif)}) chests in the Advanced Digsite` or "Find a chest in the Advanced Digsite"
	elseif goal.Type == QuestTypes.Goals.FISHING then 
		return dif > 1 and `Catch (x{_sh(dif)}) fish in the Fishing Minigame` or "Catch a fish in the Fishing Minigame"
	elseif goal.Type == QuestTypes.Goals.ADVANCED_FISHING then 
		return dif > 1 and `Catch (x{_sh(dif)}) fish in the Advanced Fishing Minigame` or "Catch a fish in the Advanced Fishing Minigame"
	elseif goal.Type == QuestTypes.Goals.ICE_OBBY then 
		return dif > 1 and `Complete the Ice Obby (x{_sh(dif)})` or "Complete the Ice Obby"
	elseif goal.Type == QuestTypes.Goals.PYRAMID_OBBY then 
		return dif > 1 and `Complete the Pyramid Obby (x{_sh(dif)})` or "Complete the Pyramid Obby"
	elseif goal.Type == QuestTypes.Goals.JUNGLE_OBBY then 
		return dif > 1 and `Complete the Jungle Obby (x{_sh(dif)})` or "Complete the Jungle Obby"
	elseif goal.Type == QuestTypes.Goals.SLED_RACE then 
		return dif > 1 and `Complete the Sled Race (x{_sh(dif)})` or "Complete the Sled Race"
	elseif goal.Type == QuestTypes.Goals.CHEST_RUSH then 
		return dif > 1 and `Complete the Chest Rush (x{_sh(dif)})` or "Complete the Chest Rush"
	elseif goal.Type == QuestTypes.Goals.CART_RIDE then 
		return dif > 1 and `Complete the Cart Ride into Preston (x{_sh(dif)})` or "Complete the Cart Ride into Preston"
	elseif goal.Type == QuestTypes.Goals.HOVERBOARD_OBBY then 
		return dif > 1 and `Complete the Hoverboard Obby (x{_sh(dif)})` or "Complete the Hoverboard Obby"
	elseif goal.Type == QuestTypes.Goals.DIAMOND_WHEEL then 
		return dif > 1 and `Spin the Diamond Wheel (x{_sh(dif)})` or "Spin the Diamond Wheel"
	elseif goal.Type == QuestTypes.Goals.ITEM_CREATOR then 
		return dif > 1 and `Complete (x{_sh(dif)}) Item Creator quests ` or "Complete an Item Creator quest"
	elseif goal.Type == QuestTypes.Goals.INDEX_PET then 
		return dif > 1 and `Index (x{_sh(dif)}) new pets` or "Index a new pet"
	elseif goal.Type == QuestTypes.Goals.BLACK_LUCKY_BLOCK then 
		return dif > 1 and `Break (x{_sh(dif)}) black lucky blocks inside the Lucky Block Minigame` or "Break a black lucky block inside the Lucky Block Minigame"
	elseif goal.Type == QuestTypes.Goals.FISH_SHARD then 
		return dif > 1 and `Collect (x{_sh(dif)}) magic shards inside one of the Fishing Minigames` or "Collect a magic shard inside one of the Fishing Minigames"
	elseif goal.Type == QuestTypes.Goals.MAGIC_POOL then 
		return dif > 1 and `Collect (x{_sh(dif)}) magic pools inside one of the Digsite Minigames` or "Collect a magic pool inside one of the Digsite Minigames"
	elseif goal.Type == QuestTypes.Goals.SELL_AT_BOOTH then 
		return dif > 1 and `Sell (x{_sh(dif)}) items at your trading booth` or "Sell an item at your trading booth"
	elseif goal.Type == QuestTypes.Goals.TRADE_PLAYER then 
		return dif > 1 and `Make (x{_sh(dif)}) trades with other players` or "Make a trade with another player"
	elseif goal.Type == QuestTypes.Goals.FREE_GIFT_IN_TRADE then 
		return dif > 1 and `Give (x{_sh(dif)}) free gifts by trading with other players` or "Give a free gift by trading with another player"
	elseif goal.Type == QuestTypes.Goals.FREE_GIFT_IN_MAIL then 
		return dif > 1 and `Give (x{_sh(dif)}) free gifts by sending mail to other players` or "Give a free gift by sending mail to another player"
	elseif goal.Type == QuestTypes.Goals.USE_SECRET_KEY then 
		return dif > 1 and `Use (x{_sh(dif)}) secret keys` or "Use a secret key"
	elseif goal.Type == QuestTypes.Goals.USE_CRYSTAL_KEY then 
		return dif > 1 and `Use (x{_sh(dif)}) crystal keys` or "Use a crystal key"
	elseif goal.Type == QuestTypes.Goals.GET_CRITICAL then 
		return dif > 1 and `Get (x{_sh(dif)}) critical hits` or "Get a critical hit"
	elseif goal.Type == QuestTypes.Goals.COLLECT_LOOTBAG then 
		return dif > 1 and `Collect (x{_sh(dif)}) lootbags` or "Collect a lootbag"
	elseif goal.Type == QuestTypes.Goals.UPGRADE_FRUIT then 
		return dif > 1 and `Make (x{_sh(dif)}) rainbow fruit using the Fruit Smoothie Machine` or "Make a rainbow fruit using the Fruit Smoothie Machine"
	elseif goal.Type == QuestTypes.Goals.PLANT_GARDEN then 
		return dif > 1 and `Plant (x{_sh(dif)}) seeds in the Garden Minigame` or "Plant a seed in the Garden Minigame"
	elseif goal.Type == QuestTypes.Goals.HIDEOUT_BREAKABLE then 
		return dif > 1 and `Break (x{_sh(dif)}) breakables in the Treasure Hideout` or "Break a breakable in the Treasure Hideout"
	elseif goal.Type == QuestTypes.Goals.XP_POTION then 
		return dif > 1 and `Consume (x{_sh(dif)}) XP Potions` or "Consume an XP Potion"
	end
	return "???"
end

[Dev-Spadow]

There seems to be some irregularities between your list, and the data I've found so far.
Was the list updated at all from the time that was implemented?

    TYPE_1(1, "Break <breakables||specific breakable> in any zone"),
    TYPE_2(2, "Hatch <Specific||any> pet"),
    TYPE_3(3, "Hatch <specific||any> egg"),
    TYPE_4(4, "Gold any pets"),
    TYPE_5(5, "Rainbow any pets"),
    TYPE_6(6, "Unlock Zones"),
    TYPE_7(7, "Earn Currency"),
    TYPE_8(8, "Break Mini-Chests in any Zone"),
    TYPE_9(9, "Diamond Breakables"),
    TYPE_10(10, "Buy potions"),
    TYPE_11(11, "Buy Enchants"),
    TYPE_12(12, "Upgrade <Specific||Any> Potions (Tier Rolled Separately"),
    TYPE_13(13, "Upgrade <Specific||Any> Enchants (Tier Rolled Separately"),
    TYPE_14(14, "Collect Potions"),
    TYPE_15(15, "Collect Enchants"),
    /**
     * Note: Types 16 and 17 seem to be missing. Unsure if unused, or, were broken so were removed.
     */
    TYPE_18(18, "Collect Free Gifts"),
    TYPE_19(19, "Fuse Pets"),
    TYPE_20(20, "Open your best Egg"),
    TYPE_21(21, "Break breakables in Best Area"),
    TYPE_22(22, "Spawn Obby Completions"),
    TYPE_23(23, "Minefield Completions"),
    TYPE_24(24, "Atlantis Completions"),
    TYPE_25(25, "Find Chest in Digsite"),
    TYPE_26(26, "Catch fish in Fishing area"),
    TYPE_27(27, "Ice Obby Completions"),
    TYPE_28(28, "Pyramid Obby Completions"),
    TYPE_29(29, "Jungle Obby Completions"),
    TYPE_30(30, "Chest Rush"),
    TYPE_31(31, "Break Coin Jars in any Area"),
    TYPE_32(32, "Break Comets in any Area"),
    TYPE_33(33, "Use Flags"),
    TYPE_34(34, "Use <Specific||Any> Potion (Tier Rolled Separately"),
    TYPE_35(35, "Use <Specific||Any> fruit"),
    TYPE_36(36, "Sled Race Completions"),
    TYPE_37(37, "Break coin jars in best area"),
    TYPE_38(38, "Break Comets in best Area"),
    TYPE_39(39, "Break Mini-Chests in best Area"),
    TYPE_40(40, "Gold pets from your best egg"),
    TYPE_41(41, "Rainbow pets from your best egg"),
    TYPE_42(42, "Hatch rare(??) <Specific||Any> pet"),
    TYPE_43(43, "Break Pinata's"),
    TYPE_44(44, "Break Lucky blocks in best Area"),
    TYPE_45(45, "Dig Chests at Advanced Digsite"),
    TYPE_46(46, "Fish at Advanced Fishing");
    ```

[chickenputty]

There seems to be some irregularities between your list, and the data I've found so far. Was the list updated at all from the time that was implemented?

Woops, I revised my comment with the corrected list

[Dev-Spadow]

@chickenputty Any changes to the typings with this update?
And any possibility with can get an API endpoint for grabbing the types?

[chickenputty]

@Dev-Spadow I've updated the post with the new values. We hope to expose this data to the API soon.

[KDBgames]

Is there any way to get a new full list of all possible quests for clan goals now?
Because we got some new quests at the moment!

[bmyte]

When it comes to querying the individual collections some require API tokens... is this something some of us can get that would allow us to read /GuildBattles and /Mastery to get more info on them? We appreciate all the API work as it helps make communication in clan battles much easier and all the RAP tracking sites are really flushing out nicely 😁

[chickenputty]

@KDBgames It's above

@bmyte Please make another ticket. Both GuildBattles and Mastery is public. There aren't any private routes.

[TheDireWolf13]

ive got this working for a 5 sec refresh and it shows how many contributors there are. would you know how to add a code to show how many each player is contributing or which api i should pull to get that from? ive got clan player id's to reference and could make into a separate txt file if needed to reference and a variable

[ItsFlipppp]