GachaManager.java 16.4 KB
Newer Older
Melledy's avatar
Melledy committed
1
2
package emu.grasscutter.game.gacha;

3
import java.io.File;
Melledy's avatar
Melledy committed
4
import java.io.FileReader;
5
6
import java.io.InputStreamReader;
import java.io.Reader;
7
import java.nio.file.*;
Melledy's avatar
Melledy committed
8
import java.util.ArrayList;
9
import java.util.Arrays;
Melledy's avatar
Melledy committed
10
11
12
13
14
15
import java.util.Collection;
import java.util.List;
import java.util.concurrent.ThreadLocalRandom;

import com.google.gson.reflect.TypeToken;

16
import com.sun.nio.file.SensitivityWatchEventModifier;
Melledy's avatar
Melledy committed
17
import emu.grasscutter.Grasscutter;
18
import emu.grasscutter.data.DataLoader;
19
import emu.grasscutter.data.GameData;
20
import emu.grasscutter.data.common.ItemParamData;
Melledy's avatar
Melledy committed
21
import emu.grasscutter.data.excels.ItemData;
22
import emu.grasscutter.database.DatabaseHelper;
23
import emu.grasscutter.game.avatar.Avatar;
24
import emu.grasscutter.game.gacha.GachaBanner.BannerType;
25
import emu.grasscutter.game.inventory.GameItem;
26
import emu.grasscutter.game.inventory.Inventory;
Melledy's avatar
Melledy committed
27
28
import emu.grasscutter.game.inventory.ItemType;
import emu.grasscutter.game.inventory.MaterialType;
Melledy's avatar
Melledy committed
29
import emu.grasscutter.game.player.Player;
Melledy's avatar
Melledy committed
30
31
32
33
import emu.grasscutter.net.proto.GachaItemOuterClass.GachaItem;
import emu.grasscutter.net.proto.GachaTransferItemOuterClass.GachaTransferItem;
import emu.grasscutter.net.proto.GetGachaInfoRspOuterClass.GetGachaInfoRsp;
import emu.grasscutter.net.proto.ItemParamOuterClass.ItemParam;
34
import emu.grasscutter.net.proto.RetcodeOuterClass.Retcode;
Melledy's avatar
Melledy committed
35
import emu.grasscutter.server.game.GameServer;
36
import emu.grasscutter.server.game.GameServerTickEvent;
Melledy's avatar
Melledy committed
37
import emu.grasscutter.server.packet.send.PacketDoGachaRsp;
CamChua_VN's avatar
CamChua_VN committed
38
import emu.grasscutter.server.packet.send.PacketGachaWishRsp;
AnimeGitB's avatar
AnimeGitB committed
39
import emu.grasscutter.utils.Utils;
Melledy's avatar
Melledy committed
40
41
42
43
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
import it.unimi.dsi.fastutil.ints.IntArrayList;
import it.unimi.dsi.fastutil.ints.IntList;
44
45
import org.greenrobot.eventbus.Subscribe;

46
47
import static emu.grasscutter.Configuration.*;

Melledy's avatar
Melledy committed
48
49
50
public class GachaManager {
	private final GameServer server;
	private final Int2ObjectMap<GachaBanner> gachaBanners;
51
	private WatchService watchService;
Melledy's avatar
Melledy committed
52
	
53
54
	private static final int starglitterId = 221;
	private static final int stardustId = 222;
55
56
	private int[] fallbackItems4Pool2Default = {11401, 11402, 11403, 11405, 12401, 12402, 12403, 12405, 13401, 13407, 14401, 14402, 14403, 14409, 15401, 15402, 15403, 15405};
	private int[] fallbackItems5Pool2Default = {11501, 11502, 12501, 12502, 13502, 13505, 14501, 14502, 15501, 15502};
57

Melledy's avatar
Melledy committed
58
59
60
61
	public GachaManager(GameServer server) {
		this.server = server;
		this.gachaBanners = new Int2ObjectOpenHashMap<>();
		this.load();
62
		this.startWatcher(server);
Melledy's avatar
Melledy committed
63
64
65
66
67
68
69
70
71
	}

	public GameServer getServer() {
		return server;
	}

	public Int2ObjectMap<GachaBanner> getGachaBanners() {
		return gachaBanners;
	}
AnimeGitB's avatar
AnimeGitB committed
72
73
	
	public int randomRange(int min, int max) {  // Both are inclusive
Melledy's avatar
Melledy committed
74
75
76
77
78
79
80
81
		return ThreadLocalRandom.current().nextInt(max - min + 1) + min;
	}
	
	public int getRandom(int[] array) {
		return array[randomRange(0, array.length - 1)];
	}
	
	public synchronized void load() {
82
		try (Reader fileReader = new InputStreamReader(DataLoader.load("Banners.json"))) {
83
			getGachaBanners().clear();
Melledy's avatar
Melledy committed
84
			List<GachaBanner> banners = Grasscutter.getGsonFactory().fromJson(fileReader, TypeToken.getParameterized(Collection.class, GachaBanner.class).getType());
85
86
			if(banners.size() > 0) {
				for (GachaBanner banner : banners) {
87
					getGachaBanners().put(banner.getScheduleId(), banner);
88
89
90
91
				}
				Grasscutter.getLogger().info("Banners successfully loaded.");
			} else {
				Grasscutter.getLogger().error("Unable to load banners. Banners size is 0.");
Melledy's avatar
Melledy committed
92
93
94
95
96
97
			}
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
AnimeGitB's avatar
AnimeGitB committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

	private class BannerPools {
		public int[] rateUpItems4;
		public int[] rateUpItems5;
		public int[] fallbackItems4Pool1;
		public int[] fallbackItems4Pool2;
		public int[] fallbackItems5Pool1;
		public int[] fallbackItems5Pool2;

		public BannerPools(GachaBanner banner) {
			rateUpItems4 = banner.getRateUpItems4();
			rateUpItems5 = banner.getRateUpItems5();
			fallbackItems4Pool1 = banner.getFallbackItems4Pool1();
			fallbackItems4Pool2 = banner.getFallbackItems4Pool2();
			fallbackItems5Pool1 = banner.getFallbackItems5Pool1();
			fallbackItems5Pool2 = banner.getFallbackItems5Pool2();

			if (banner.getAutoStripRateUpFromFallback()) {
				fallbackItems4Pool1 = Utils.setSubtract(fallbackItems4Pool1, rateUpItems4);
				fallbackItems4Pool2 = Utils.setSubtract(fallbackItems4Pool2, rateUpItems4);
				fallbackItems5Pool1 = Utils.setSubtract(fallbackItems5Pool1, rateUpItems5);
				fallbackItems5Pool2 = Utils.setSubtract(fallbackItems5Pool2, rateUpItems5);
			}
		}

		public void removeFromAllPools(int[] itemIds) {
			rateUpItems4 = Utils.setSubtract(rateUpItems4, itemIds);
			rateUpItems5 = Utils.setSubtract(rateUpItems5, itemIds);
			fallbackItems4Pool1 = Utils.setSubtract(fallbackItems4Pool1, itemIds);
			fallbackItems4Pool2 = Utils.setSubtract(fallbackItems4Pool2, itemIds);
			fallbackItems5Pool1 = Utils.setSubtract(fallbackItems5Pool1, itemIds);
			fallbackItems5Pool2 = Utils.setSubtract(fallbackItems5Pool2, itemIds);
		}
	}

	private synchronized int checkPlayerAvatarConstellationLevel(Player player, int itemId) {  // Maybe this would be useful in the Player class?
		ItemData itemData = GameData.getItemDataMap().get(itemId);
		if ((itemData == null) || (itemData.getMaterialType() != MaterialType.MATERIAL_AVATAR)){
			return -2;  // Not an Avatar
		}
		Avatar avatar = player.getAvatars().getAvatarById((itemId % 1000) + 10000000);
		if (avatar == null) {
			return -1;  // Doesn't have
		}
		// Constellation
		int constLevel = avatar.getCoreProudSkillLevel();
		GameItem constItem = player.getInventory().getInventoryTab(ItemType.ITEM_MATERIAL).getItemById(itemId + 100);
		constLevel += (constItem == null)? 0 : constItem.getCount();
		return constLevel;
	}

	private synchronized int[] removeC6FromPool(int[] itemPool, Player player) {
		IntList temp = new IntArrayList();
		for (int itemId : itemPool) {
			if (checkPlayerAvatarConstellationLevel(player, itemId) < 6) {
				temp.add(itemId);
			}
		}
		return temp.toIntArray();
	}

	private synchronized int drawRoulette(int[] weights, int cutoff) {
		// This follows the logic laid out in issue #183
		// Simple weighted selection with an upper bound for the roll that cuts off trailing entries
		// All weights must be >= 0
		int total = 0;
164
165
		for (int weight : weights) {
			if (weight < 0) {
AnimeGitB's avatar
AnimeGitB committed
166
167
				throw new IllegalArgumentException("Weights must be non-negative!");
			}
168
			total += weight;
AnimeGitB's avatar
AnimeGitB committed
169
170
171
		}
		int roll = ThreadLocalRandom.current().nextInt((total < cutoff)? total : cutoff);
		int subTotal = 0;
172
173
		for (int i=0; i<weights.length; i++) {
			subTotal += weights[i];
AnimeGitB's avatar
AnimeGitB committed
174
175
176
177
178
179
180
181
			if (roll < subTotal) {
				return i;
			}
		}
		// throw new IllegalStateException();
		return 0;  // This should only be reachable if total==0
	}

CamChua_VN's avatar
CamChua_VN committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
	private synchronized int doFallbackRarePull(int[] fallback1, int[] fallback2, int rarity, GachaBanner banner, PlayerGachaBannerInfo gachaInfo) {
		if (fallback1.length < 1) {
			if (fallback2.length < 1) {
				return getRandom((rarity==5)? fallbackItems5Pool2Default : fallbackItems4Pool2Default);
			} else {
				return getRandom(fallback2);
			}
		} else if (fallback2.length < 1) {
			return getRandom(fallback1);
		} else {  // Both pools are possible, use the pool balancer
			int pityPool1 = banner.getPoolBalanceWeight(rarity, gachaInfo.getPityPool(rarity, 1));
			int pityPool2 = banner.getPoolBalanceWeight(rarity, gachaInfo.getPityPool(rarity, 2));
			int chosenPool = switch ((pityPool1 >= pityPool2)? 1 : 0) {  // Larger weight must come first for the hard cutoff to function correctly
				case 1 -> 1 + drawRoulette(new int[] {pityPool1, pityPool2}, 10000);
				default -> 2 - drawRoulette(new int[] {pityPool2, pityPool1}, 10000);
			};
			return switch (chosenPool) {
				case 1:
					gachaInfo.setPityPool(rarity, 1, 0);
					yield getRandom(fallback1);
				default:
					gachaInfo.setPityPool(rarity, 2, 0);
					yield getRandom(fallback2);
			};
		}
	}

AnimeGitB's avatar
AnimeGitB committed
209
210
	private synchronized int doRarePull(int[] featured, int[] fallback1, int[] fallback2, int rarity, GachaBanner banner, PlayerGachaBannerInfo gachaInfo) {
		int itemId = 0;
CamChua_VN's avatar
CamChua_VN committed
211
212
213
214
215
216
217
218
219
		boolean epitomized = (banner.hasEpitomized()) && (rarity == 5) && (gachaInfo.getWishItemId() != 0);
		boolean pityEpitomized = (gachaInfo.getFailedChosenItemPulls() >= banner.getWishMaxProgress());  // Maximum fate points reached
		boolean pityFeatured = (gachaInfo.getFailedFeaturedItemPulls(rarity) >= 1);  // Lost previous coinflip
		boolean rollFeatured = (this.randomRange(1, 100) <= banner.getEventChance(rarity));  // Won this coinflip
		boolean pullFeatured = pityFeatured || rollFeatured;

		if (epitomized && pityEpitomized) {  // Auto pick item when epitomized points reached
			gachaInfo.setFailedFeaturedItemPulls(rarity, 0);  // Epitomized item will always be a featured one
			itemId = gachaInfo.getWishItemId();
AnimeGitB's avatar
AnimeGitB committed
220
		} else {
CamChua_VN's avatar
CamChua_VN committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
			if (pullFeatured && (featured.length > 0)) {
				gachaInfo.setFailedFeaturedItemPulls(rarity, 0);
				itemId = getRandom(featured);
			} else {
				gachaInfo.addFailedFeaturedItemPulls(rarity, 1);  // This could be moved into doFallbackRarePull but having it here makes it clearer
				itemId = doFallbackRarePull(fallback1, fallback2, rarity, banner, gachaInfo);
			}
		}

		if (epitomized) {
			if(itemId == gachaInfo.getWishItemId()) { // Reset epitomized points when got wished item
				gachaInfo.setFailedChosenItemPulls(0);
			} else { // Add epitomized points if not get wished item
				gachaInfo.addFailedChosenItemPulls(1);
AnimeGitB's avatar
AnimeGitB committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
			}
		}
		return itemId;
	}

	private synchronized int doPull(GachaBanner banner, PlayerGachaBannerInfo gachaInfo, BannerPools pools) {
		// Pre-increment all pity pools (yes this makes all calculations assume 1-indexed pity)
		gachaInfo.incPityAll();

		int[] weights = {banner.getWeight(5, gachaInfo.getPity5()), banner.getWeight(4, gachaInfo.getPity4()), 10000};
		int levelWon = 5 - drawRoulette(weights, 10000);

		return switch (levelWon) {
			case 5:
				gachaInfo.setPity5(0);
				yield doRarePull(pools.rateUpItems5, pools.fallbackItems5Pool1, pools.fallbackItems5Pool2, 5, banner, gachaInfo);
			case 4:
				gachaInfo.setPity4(0);
				yield doRarePull(pools.rateUpItems4, pools.fallbackItems4Pool1, pools.fallbackItems4Pool2, 4, banner, gachaInfo);
			default:
				yield getRandom(banner.getFallbackItems3());
		};
	}
Melledy's avatar
Melledy committed
258
	
259
	public synchronized void doPulls(Player player, int scheduleId, int times) {
Melledy's avatar
Melledy committed
260
261
262
263
		// Sanity check
		if (times != 10 && times != 1) {
			return;
		} 
264
265
		Inventory inventory = player.getInventory();
		if (inventory.getInventoryTab(ItemType.ITEM_WEAPON).getSize() + times > inventory.getInventoryTab(ItemType.ITEM_WEAPON).getMaxCapacity()) {
266
			player.sendPacket(new PacketDoGachaRsp(Retcode.RET_ITEM_EXCEED_LIMIT));
Melledy's avatar
Melledy committed
267
268
269
270
			return;
		}
		
		// Get banner
271
		GachaBanner banner = this.getGachaBanners().get(scheduleId);
Melledy's avatar
Melledy committed
272
273
274
275
276
277
		if (banner == null) {
			player.sendPacket(new PacketDoGachaRsp());
			return;
		}

		// Spend currency
278
279
		ItemParamData cost = banner.getCost(times);
		if (cost.getCount() > 0 && !inventory.payItem(cost)) {
280
			player.sendPacket(new PacketDoGachaRsp());
281
			return;
Melledy's avatar
Melledy committed
282
283
284
		}
		
		// Add to character
AnimeGitB's avatar
AnimeGitB committed
285
286
		PlayerGachaBannerInfo gachaInfo = player.getGachaInfo().getBannerInfo(banner);
		BannerPools pools = new BannerPools(banner);
Melledy's avatar
Melledy committed
287
288
		List<GachaItem> list = new ArrayList<>();
		int stardust = 0, starglitter = 0;
AnimeGitB's avatar
AnimeGitB committed
289
290
291
292
293
294
295
296
297

		if (banner.getRemoveC6FromPool()) {  // The ultimate form of pity (non-vanilla)
			pools.rateUpItems4 = removeC6FromPool(pools.rateUpItems4, player);
			pools.rateUpItems5 = removeC6FromPool(pools.rateUpItems5, player);
			pools.fallbackItems4Pool1 = removeC6FromPool(pools.fallbackItems4Pool1, player);
			pools.fallbackItems4Pool2 = removeC6FromPool(pools.fallbackItems4Pool2, player);
			pools.fallbackItems5Pool1 = removeC6FromPool(pools.fallbackItems5Pool1, player);
			pools.fallbackItems5Pool2 = removeC6FromPool(pools.fallbackItems5Pool2, player);
		}
Melledy's avatar
Melledy committed
298
		
AnimeGitB's avatar
AnimeGitB committed
299
300
301
		for (int i = 0; i < times; i++) {
			// Roll
			int itemId = doPull(banner, gachaInfo, pools);
302
			ItemData itemData = GameData.getItemDataMap().get(itemId);
Melledy's avatar
Melledy committed
303
			if (itemData == null) {
AnimeGitB's avatar
AnimeGitB committed
304
				continue;  // Maybe we should bail out if an item fails instead of rolling the rest?
Melledy's avatar
Melledy committed
305
			}
306
307

			// Write gacha record
308
			GachaRecord gachaRecord = new GachaRecord(itemId, player.getUid(), banner.getGachaType());
309
			DatabaseHelper.saveGachaRecord(gachaRecord);
Melledy's avatar
Melledy committed
310
311
312
313
314
315
316
			
			// Create gacha item
			GachaItem.Builder gachaItem = GachaItem.newBuilder();
			int addStardust = 0, addStarglitter = 0;
			boolean isTransferItem = false;
			
			// Const check
AnimeGitB's avatar
AnimeGitB committed
317
318
319
320
321
322
323
			int constellation = checkPlayerAvatarConstellationLevel(player, itemId);
			switch (constellation) {
				case -2:  // Is weapon
					switch (itemData.getRankLevel()) {
						case 5 -> addStarglitter = 10;
						case 4 -> addStarglitter = 2;
						default -> addStardust = 15;
Melledy's avatar
Melledy committed
324
					}
AnimeGitB's avatar
AnimeGitB committed
325
326
327
328
329
330
331
332
333
334
335
336
337
					break;
				case -1:  // New character
					gachaItem.setIsGachaItemNew(true);
					break;
				default:
					if (constellation >= 6) {  // C6, give consolation starglitter
						addStarglitter = (itemData.getRankLevel()==5)? 25 : 5;
					} else {  // C0-C5, give constellation item
						if (banner.getRemoveC6FromPool() && constellation == 5) {  // New C6, remove it from the pools so we don't get C7 in a 10pull
							pools.removeFromAllPools(new int[] {itemId});
						}
						addStarglitter = (itemData.getRankLevel()==5)? 10 : 2;
						int constItemId = itemId + 100;
338
						GameItem constItem = inventory.getInventoryTab(ItemType.ITEM_MATERIAL).getItemById(constItemId);
Melledy's avatar
Melledy committed
339
						gachaItem.addTransferItems(GachaTransferItem.newBuilder().setItem(ItemParam.newBuilder().setItemId(constItemId).setCount(1)).setIsTransferItemNew(constItem == null));
340
						inventory.addItem(constItemId, 1);
Melledy's avatar
Melledy committed
341
342
					}
					isTransferItem = true;
AnimeGitB's avatar
AnimeGitB committed
343
					break;
Melledy's avatar
Melledy committed
344
345
346
			}

			// Create item
347
			GameItem item = new GameItem(itemData);
Melledy's avatar
Melledy committed
348
			gachaItem.setGachaItem(item.toItemParam());
349
			inventory.addItem(item);
Melledy's avatar
Melledy committed
350
351
352
353
354
355
			
			stardust += addStardust;
			starglitter += addStarglitter;
			
			if (addStardust > 0) {
				gachaItem.addTokenItemList(ItemParam.newBuilder().setItemId(stardustId).setCount(addStardust));
AnimeGitB's avatar
AnimeGitB committed
356
357
			}
			if (addStarglitter > 0) {
Melledy's avatar
Melledy committed
358
359
360
361
362
363
364
365
366
367
368
369
				ItemParam starglitterParam = ItemParam.newBuilder().setItemId(starglitterId).setCount(addStarglitter).build();
				if (isTransferItem) {
					gachaItem.addTransferItems(GachaTransferItem.newBuilder().setItem(starglitterParam));
				}
				gachaItem.addTokenItemList(starglitterParam);
			}
			
			list.add(gachaItem.build());
		}
		
		// Add stardust/starglitter
		if (stardust > 0) {
370
			inventory.addItem(stardustId, stardust);
AnimeGitB's avatar
AnimeGitB committed
371
372
		}
		if (starglitter > 0) {
373
			inventory.addItem(starglitterId, starglitter);
Melledy's avatar
Melledy committed
374
375
376
		}
		
		// Packets
CamChua_VN's avatar
CamChua_VN committed
377
		player.sendPacket(new PacketDoGachaRsp(banner, list, gachaInfo));
Melledy's avatar
Melledy committed
378
	}
379
380
381
382
383

	private synchronized void startWatcher(GameServer server) {
		if(this.watchService == null) {
			try {
				this.watchService = FileSystems.getDefault().newWatchService();
384
				Path path = new File(DATA()).toPath();
385
				path.register(watchService, new WatchEvent.Kind[]{StandardWatchEventKinds.ENTRY_MODIFY}, SensitivityWatchEventModifier.HIGH);
386
387
388
389
390
391
392
393
394
395
396
			} catch (Exception e) {
				Grasscutter.getLogger().error("Unable to load the Gacha Manager Watch Service. If ServerOptions.watchGacha is true it will not auto-reload");
				e.printStackTrace();
			}
		} else {
			Grasscutter.getLogger().error("Cannot reinitialise watcher ");
		}
	}

	@Subscribe
	public synchronized void watchBannerJson(GameServerTickEvent tickEvent) {
397
		if(GAME_OPTIONS.watchGachaConfig) {
Benjamin Elsdon's avatar
Benjamin Elsdon committed
398
			try {
399
400
				WatchKey watchKey = watchService.take();

Benjamin Elsdon's avatar
Benjamin Elsdon committed
401
402
403
404
405
406
				for (WatchEvent<?> event : watchKey.pollEvents()) {
					final Path changed = (Path) event.context();
					if (changed.endsWith("Banners.json")) {
						Grasscutter.getLogger().info("Change detected with banners.json. Reloading gacha config");
						this.load();
					}
407
				}
408
409
410
411
412
413

				boolean valid = watchKey.reset();
				if (!valid) {
					Grasscutter.getLogger().error("Unable to reset Gacha Manager Watch Key. Auto-reload of banners.json will no longer work.");
					return;
				}
Benjamin Elsdon's avatar
Benjamin Elsdon committed
414
415
			} catch (Exception e) {
				e.printStackTrace();
416
417
418
			}
		}
	}
Melledy's avatar
Melledy committed
419
	
420
	private synchronized GetGachaInfoRsp createProto(Player player) {
421
422
		GetGachaInfoRsp.Builder proto = GetGachaInfoRsp.newBuilder().setGachaRandom(12345);
		
423
424
		long currentTime = System.currentTimeMillis() / 1000L;

425
		for (GachaBanner banner : getGachaBanners().values()) {
426
427
			if ((banner.getEndTime() >= currentTime && banner.getBeginTime() <= currentTime) || (banner.getBannerType() == BannerType.STANDARD))
			{
428
				proto.addGachaInfoList(banner.toProto(player));
429
			}
430
431
432
433
434
		}
				
		return proto.build();
	}

435
436
	public GetGachaInfoRsp toProto(Player player) {
		return createProto(player);
437
	}
Melledy's avatar
Melledy committed
438
}