RandomLoadoutGenerator 1.1.0

Overview

A C# library that allows you to choose random weapons from all weapons available in Team Fortress 2. You can specify for what class and for what slot should a weapon be randomized.

This library supports weapons that are multi-class and are equippable in different slots, for example The Panic Attack or The B.A.S.E. Jumper.

It's also possible to tell the Generator to treat weapon reskins as a single weapon to increase the odds of rolling mechanically different unlockable weapons. This way you can minimize the odds of pulling different melee reskins 5 times in a row.

You can also just remove weapons from being a possible outcome.

Boring details

It uses a small built-in SQLite packaged as an embedded resource. When you create a Generator instance, it unpacks this database into the Environment.CurrentDirectory (usually the same directory where your app's executable is). This database is queried once for every Generator instance. Any changes in that Generator instance will not be preserved inside the database file.

The database contains all weapons in Team Fortress 2 listed on the official Wiki's page. All of them are in the pool of possible outcomes by default. A few expensive and hard/impossible-to-obtain variants are disabled by default from the weapon pool. These are:

• Golden Wrench
• Saxxy
• Golden Frying Pan
• Memory Maker

All weapons follow the TFSlot.Primary, TFSlot.Secondary and TFSlot.Melee slots the same way they do in Team Fortress 2. The exception are Spy's invisibility watches, they are treated as TFSlot.Secondary. Spy's sappers are the only weapons to use TFSlot.Sapper slot.

Usage

Just create a new Generator instance and use its methods:

var generator = new Generator();
var weapon = generator.RandomizeWeapon(TFClass.Scout, TFSlot.Primary);
Console.WriteLine(weapon.ToString());

To randomize things like classes and loadout slots, Generator has static methods for it. The Generator.RandomizeSlot() method by default won't output a TFSlot.Sapper, unless you supply a true argument. The reason why is because telling Generator to randomize a sapper for Pyro will throw ArgumentException.

using RandomLoadoutGenerator;

var randomClass = Generator.RandomizeClass();
var randomSlot = Generator.RandomizeSlot();         
var randomSlot2 = Generator.RandomizeSlot(true);    //has a chance to be a TFSlot.Sapper

You can enable Generator to treat weapon reskins as a single weapon and have higher chances of returning a mechanically unique weapon by adding true as last 3rd argument.

var weapon = generator.RandomizeWeapon(TFClass.Scout, TFSlot.Melee, true);

You can disable and enable weapons to completely disallow them from being a possible outcome. You can choose the weapon to enable/disable by passing its ID. You can reference the ID table at the bottom of this README.md.

Attempting to randomize, for example a Secondary for Heavy, while all Heavy's secondary weapons are disabled, will throw an InvalidOperationException. Generator will not be able to randomize a weapon when all weapons meeting the loadout combination criteria are disabled.

Keep in mind that disabled weapons will be disabled only for that instance. A new Generator instance will have weapons with their respective initial Weapon.IsEnabled values.

generator.EnableWeapon(0, 3);
generator.DisableWeapon(1, 2, 3, 4);
generator.DisableWeapon(121);

You can check what weapons are disabled or enabled in total, for each slot, for each class or a combination of the two. Each getter method returns an IEnumerable<Weapon>.

var allEnabledWeapons = generator.GetEnabledWeapons();
var enabledPyroWeapons = generator.GetEnabledWeapons(TFClass.Pyro);
var disabledSniperSecondaries = generator.GetDisabledWeapons(TFClass.Sniper, TFSlot.Secondary);
var allWeaponsForDemoman = generator.GetAllWeapons(TFClass.Demoman);

You can also take a look at examples folder on the GitHub repository for an example project. It's a simple console app that generates a new random loadout for a random class everytime you press Enter.

Weapon ID table

* - these weapons are disabled from the weapon pool by default.