Add witty/stupid comments to a few classes

This commit is contained in:
Electroblob
2018-06-05 21:26:07 +01:00
parent 726a306830
commit dec5b1ac2c
5 changed files with 19 additions and 0 deletions
@@ -31,6 +31,16 @@ import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
import net.minecraftforge.fml.common.network.NetworkRegistry;
import net.minecraftforge.fml.common.registry.GameRegistry;
/**
* <i>"Electroblob's Wizardry adds an RPG-like system of spells to Minecraft, with the aim of being as playable as
* possible. No crazy constructs, no perk trees, no complex recipes - simply find spell books, cast spells, and master
* the arcane! - But you knew that, right?"</i>
* <p>
* Main mod class for Wizardry. Contains the logger and settings instances, along with all the other stuff that's normally
* in a main mod class.
* @author Electroblob
* @since Wizardry 1.0
*/
@Mod(modid = Wizardry.MODID, name = Wizardry.NAME, version = Wizardry.VERSION, guiFactory = "electroblob.wizardry.WizardryGuiFactory")
public class Wizardry {
@@ -45,6 +45,8 @@ import net.minecraft.util.EntityDamageSource;
// type 'attributes'. This is my attempt to collect all of these into a reasonably coherent system.
/**
* <i>"Ouch, that hurt!"</i>
* <p>
* As of wizardry 1.1, this class has replaced the damagesource-related methods in WizardryUtilities, allowing a
* {@link DamageType} to be specified with the damage. The main reason for this is so that damage sources can fit with
* the vanilla behaviour on armour enchantments and such like whilst still being classified as wizardry damage for the
@@ -12,6 +12,8 @@ import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.fml.common.network.ByteBufUtils;
/**
* <i>"{@code SpellModifiers} - modify all the things!"</i>
* <p>
* Object that wraps any number of spell modifiers into one, allowing for expandability within the Spell#cast methods.
* This class is essentially a glorified {@link Map} which can be written to and read from a {@link ByteBuf}. It is
* possible to calculate spell modifiers from wand NBT within the cast methods, but this is cumbersome and does not
@@ -12,6 +12,8 @@ import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
/**
* <i>"Never fear, {@code WandHelper} is here!"</i>
* <p>
* Much like {@link net.minecraft.enchantment.EnchantmentHelper EnchantmentHelper}, this class has some static methods
* which allow cleaner and more concise interaction with the wand NBT data, which is quite a complex structure. Such
* interaction previously resulted in rather verbose and repetitive code which was hard to read and even harder to
@@ -59,6 +59,9 @@ import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;
/**
* <i>"Where do you put random but useful bits and pieces? {@code WizardryUtilities} of course - the 'stuff that doesn't
* fit anywhere else' class!"</i>
* <p>
* This class contains some useful static methods for use anywhere - items, entities, spells, events, blocks, etc.
* Broadly speaking, these fall into the following categories:
* <p>