public static void Add()
{
// So, you want to create a new gun?
// Get yourself a new gun "base" first.
// Let's just call it "Test Gun", and use "gshbd" for all sprites and as "codename".
Gun gun = ETGMod.Databases.Items.NewGun("Test Gun", "gshbd");
//FIXME Test Gun respects Gungeon.Items, so we remove it from the catch-all namespace
Game.Items.Rename("outdated_gun_mods:test_gun", "etgmod:test_gun");
// If you really want to, you can pass another gun object between the name and short name.
// That gun then gets "cleared" to be a base gun for your modded gun.
// If you want to transform from another gun, do it now,
// otherwise that transformation overwrites everything else that comes now.
// Let's add THIS CLASS as a component to the gun.
// GunBehaviour offers some methods to be overriden (f.e. PostProcessProjectile)
// and creating your own GunBehaviour as a ModGunController makes creating modded guns easier.
gun.gameObject.AddComponent <TestGunController>();
// Here we tell Gungeon about the description of the gun.
// If you want to use per-language descriptions, use the ETGMod.Databases.Strings.OnLanguageChanged
// field, += your own delegate there and update the descriptions.
// (You can also gun.SetName in that hook.)
gun.SetShortDescription("Hello, World!");
gun.SetLongDescription("Legend tells that this gun has been handcrafted by a team of Gungeoneers that managed to escape into outer reality. A worn engraving on the barrel reads \"JSON\". Hopefully, the previous owner was a better gunsmith than he was a speller.");
// This is required, unless you want to use the sprites of the base gun.
// That, by default, is the pea shooter.
// SetupSprite sets up the default gun sprite for the ammonomicon and the "gun get" popup.
// WARNING: Add a copy of your default sprite to Ammonomicon Encounter Icon Collection!
// That means, "sprites/Ammonomicon Encounter Icon Collection/defaultsprite.png" in your mod .zip
gun.SetupSprite(defaultSprite: "gshbd_fire_002", fps: 10);
// ETGMod automatically checks which animations are available.
// If you want to, you can set the FPS of those animations individually.
gun.SetAnimationFPS(gun.shootAnimation, 40);
// This is how you add "projectile modules". Each shoot, all the projectile modules
// fire at once. The DefaultModule is the first added projectile module.
// If you know you won't modify the projectiles at all, feel free to add "clonedProjectiles: false" (done here).
// WARNING: The gun names are the names from the JSON dump! If you are not sure, ask one of the other modders
// who have got the JSON dump for either a copy of it, or the name of the gun.
// (You can also pass a gun here.)
// WARNING: At this point, both the other gun needs a DefaultModule and your mod gun needs a Volley!
// If you touched your Volley in any way, please don't blame us for this erroring.
gun.AddProjectileModuleFrom("AK-47", clonedProjectiles: false);
// Here we just take the default projectile module and change its settings how we want it to be.
gun.DefaultModule.ammoCost = 1;
gun.DefaultModule.shootStyle = ProjectileModule.ShootStyle.SemiAutomatic;
gun.DefaultModule.sequenceStyle = ProjectileModule.ProjectileSequenceStyle.Random;
gun.reloadTime = 2.25f;
gun.SetBaseMaxAmmo(200);
gun.DefaultModule.numberOfShotsInClip = 15;
// This is the test gun. If you don't know about the test gun, it shoots *every possible projectile, except beams*.
// While all projectile modules shoot at once, projectiles themselves get picked either sequentially or randomly.
// This way you can make your gun shoot random projectiles.
for (int i = 0; i < ETGMod.Databases.Items.Count; i++)
{
Gun other = ETGMod.Databases.Items[i] as Gun;
if (other == null)
{
continue;
}
if (other.DefaultModule.shootStyle == ProjectileModule.ShootStyle.Beam)
{
continue;
}
// Same applies as above: Your mod gun needs a volley, the other gun needs a projectile module with projectile,
// and cloned: false just means you won't modify the projectile. Set it to true / remove it if you modify
// the projectiles to not affect other guns.
gun.AddProjectileFrom(other, cloned: false);
}
// Here we just set the quality of the gun and the "EncounterGuid", which is used by Gungeon to identify the gun.
gun.quality = PickupObject.ItemQuality.S;
gun.encounterTrackable.EncounterGuid = "Test Gun Please Ignore"; // Update this GUID when you need to "refresh" the gun.
// Finally, we add the gun to the items list. It takes care of more than just that (loot mapping, encounter DB).
ETGMod.Databases.Items.Add(gun);
}
public static Projectile AddProjectileFrom(this Gun gun, string other, bool cloned = true)
{
return(gun.AddProjectileFrom((Gun)ETGMod.Databases.Items[other], cloned));
}
