fujin/Wizardry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

That's one heck of a commit you've got there...

Browse Source 
I may have got a bit behind with version control. A lot behind, in fact. Maybe I'll go back and split this sometime - then again, I probably won't. But hey, at least it's here!
This commit is contained in:
Electroblob77
2019-08-18 00:04:18 +01:00
parent 2680d02304
commit f37812be3e
1564 changed files with 47652 additions and 12984 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/electroblob/wizardry/event/DiscoverSpellEvent.java
+23 -4
View File
@@ -6,6 +6,8 @@ import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.common.eventhandler.Cancelable;
import javax.annotation.Nullable;
/**
* DiscoverSpellEvent is fired when a player discovers a spell by any method.<br>
* <br>
@@ -41,13 +43,30 @@ public class DiscoverSpellEvent extends PlayerEvent {
public enum Source {
/** Signifies that the spell was discovered by trying to cast it. */
CASTING,
CASTING("casting"),
/** Signifies that the spell was discovered using a scroll of identification. */
IDENTIFICATION_SCROLL,
IDENTIFICATION_SCROLL("identification_scroll"),
/** Signifies that the spell was discovered using commands. */
COMMAND,
COMMAND("command"),
/** Signifies that the spell was discovered by purchasing it from a wizard. */
PURCHASE("purchase"),
/** Signifies that the spell was discovered by some other means. */
OTHER
OTHER("other");
String name;
Source(String name){
this.name = name;
}
/** Returns the spell discovery source with the given name, or null if no such source exists. */
@Nullable
public static Source byName(String name){
for(Source source : values()){
if(source.name.equals(name)) return source;
}
return null;
}
}
}
src/main/java/electroblob/wizardry/event/SpellCastEvent.java
+144 -16
View File
@@ -1,34 +1,71 @@
package electroblob.wizardry.event;
import electroblob.wizardry.data.WizardData;
import electroblob.wizardry.entity.living.ISpellCaster;
import electroblob.wizardry.spell.Spell;
import electroblob.wizardry.util.SpellModifiers;
import net.minecraft.entity.EntityLivingBase;
import net.minecraft.util.EnumFacing;
import net.minecraft.world.World;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.living.LivingEvent;
import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event;
import javax.annotation.Nullable;
/**
* SpellCastEvent is the parent event class for all spell casting events. Methods which subscribe to this event will
* receive all three child events (it is recommended that you use {@link SpellCastEvent.Pre},
* {@link SpellCastEvent.Post} or {@link SpellCastEvent.Tick}, depending on the application).<br>
* receive all four child events (it is recommended that you use {@link SpellCastEvent.Pre},
* {@link SpellCastEvent.Post}, {@link SpellCastEvent.Tick} or {@link SpellCastEvent.Finish}, depending on the application).<br>
* <br>
* <i>A note about spell modifiers: As of Wizardry 4.2, item-based spell casting has been reorganised, a notable change
* being that spell modifiers are no longer recalculated each tick for continuous spells. Instead, spell modifiers
* are stored in {@link WizardData WizardData} at the start (after {@code SpellCastEvent.Pre})
* and simply passed in each tick. This means the {@code SpellModifiers} object received by {@code SpellCastEvent.Tick}
* contains those modified values, and any changes made to them will <b>not</b> persist between ticks.
* <p></p>
* This means that where before you had to change the modifiers in {@code Pre} <b>and</b> {@code Tick}, you now only
* need to change them in {@code Pre} unless you want them to change partway through casting.</i>
* <p></p>
* This event is fired on the {@link MinecraftForge#EVENT_BUS}.
*
* @author Electroblob
* @since Wizardry 2.1
*/
public abstract class SpellCastEvent extends LivingEvent {
public abstract class SpellCastEvent extends Event {
private final Spell spell;
private final SpellModifiers modifiers;
private final Source source;
private final EntityLivingBase caster;
private final World world;
private final double x, y, z;
private final EnumFacing direction;
public SpellCastEvent(EntityLivingBase caster, Spell spell, SpellModifiers modifiers, Source source){
super(caster);
public SpellCastEvent(Source source, Spell spell, EntityLivingBase caster, SpellModifiers modifiers){
super();
this.spell = spell;
this.modifiers = modifiers;
this.source = source;
this.caster = caster;
this.world = caster.world; // World is required for the position-based casting, but we may as well set it here
this.x = Double.NaN; // Better to use NaN than some arbitrary number, because NaN will throw an exception when
this.y = Double.NaN; // someone tries to operate on it whereas 0, for example, will likely just cause strange
this.z = Double.NaN; // behaviour - the cause of which may not be immediately obvious.
this.direction = null;
}
public SpellCastEvent(Source source, Spell spell, World world, double x, double y, double z, EnumFacing direction, SpellModifiers modifiers){
super();
this.spell = spell;
this.modifiers = modifiers;
this.source = source;
this.caster = null;
this.world = world;
this.x = x;
this.y = y;
this.z = z;
this.direction = direction;
}
/** Returns the spell being cast. */
@@ -45,6 +82,39 @@ public abstract class SpellCastEvent extends LivingEvent {
public Source getSource(){
return source;
}
/** Returns the entity that cast this spell, or null if it was cast from a dispenser or a command with coordinates. */
@Nullable
public EntityLivingBase getCaster(){
return caster;
}
/** Returns the world in which this spell was cast. If the spell was cast by an entity, this is equivalent to
* {@code getCaster().world}. */
public World getWorld(){
return world;
}
/** Returns the x coordinate at which this spell was cast, or NaN if the spell was not cast from a position. */
public double getX(){
return x;
}
/** Returns the y coordinate at which this spell was cast, or NaN if the spell was not cast from a position. */
public double getY(){
return y;
}
/** Returns the z coordinate at which this spell was cast, or NaN if the spell was not cast from a position. */
public double getZ(){
return z;
}
/** Returns the direction in which this spell was cast, or null if the spell was not cast from a position. */
@Nullable
public EnumFacing getDirection(){
return direction;
}
public enum Source {
/** Signifies that the spell was cast using a wand. */
@@ -55,6 +125,8 @@ public abstract class SpellCastEvent extends LivingEvent {
COMMAND,
/** Signifies that the spell was cast by an {@link ISpellCaster}. */
NPC,
/** Signifies that the spell was cast from a dispenser. */
DISPENSER,
/** Signifies that the spell was cast by some other means. */
OTHER
}
@@ -70,6 +142,13 @@ public abstract class SpellCastEvent extends LivingEvent {
* right-click action that caused it (if any) returns a result of FAIL, meaning that the right-click is passed to
* the block/entity in front of the player, if any.<br>
* <br>
* <b>Priority convention for {@code SpellCastEvent.Pre}:</b><br>
* {@code HIGHEST} - General spell prevention e.g. arcane jammer<br>
* {@code HIGH} - Specific spell prevention e.g. spells disabled in config/JSONs<br>
* {@code NORMAL} - Everything else e.g. forfeits<br>
* {@code LOW} - Changes to modifiers e.g. from potion effects<br>
* {@code LOWEST} - Anything that requires modifiers to be at their final values, unused in wizardry<br>
* <br>
* This event does not have a result. {@link HasResult}<br>
* <br>
* This event is fired on the {@link MinecraftForge#EVENT_BUS}.
@@ -80,10 +159,13 @@ public abstract class SpellCastEvent extends LivingEvent {
@Cancelable
public static class Pre extends SpellCastEvent {
public Pre(EntityLivingBase caster, Spell spell, SpellModifiers modifiers, Source source){
super(caster, spell, modifiers, source);
public Pre(Source source, Spell spell, EntityLivingBase caster, SpellModifiers modifiers){
super(source, spell, caster, modifiers);
}
public Pre(Source source, Spell spell, World world, double x, double y, double z, EnumFacing direction, SpellModifiers modifiers){
super(source, spell, world, x, y, z, direction, modifiers);
}
}
/**
@@ -91,7 +173,8 @@ public abstract class SpellCastEvent extends LivingEvent {
* whether the spell succeeds, and does not affect the spell itself. For example, wizardry uses this event to keep
* track of spellcasting stats. Note that although this event is fired from both sides, it is not fired from common
* code; rather, both sides fire it separately, so timing is not guaranteed. Also note that this event is only fired
* once for continuous spells, after the first casting tick.<br>
* once for continuous spells, after the first casting tick. Changing the modifiers within this event will likely
* have no effect, with the exception of cooldown modifiers.<br>
* <br>
* This event is not {@link Cancelable}.<br>
* <br>
@@ -104,8 +187,12 @@ public abstract class SpellCastEvent extends LivingEvent {
*/
public static class Post extends SpellCastEvent {
public Post(EntityLivingBase caster, Spell spell, SpellModifiers modifiers, Source source){
super(caster, spell, modifiers, source);
public Post(Source source, Spell spell, EntityLivingBase caster, SpellModifiers modifiers){
super(source, spell, caster, modifiers);
}
public Post(Source source, Spell spell, World world, double x, double y, double z, EnumFacing direction, SpellModifiers modifiers){
super(source, spell, world, x, y, z, direction, modifiers);
}
}
@@ -114,8 +201,9 @@ public abstract class SpellCastEvent extends LivingEvent {
* SpellCastEvent.Tick is fired each tick while a continuous spell is being cast.<br>
* <br>
* This event is {@link Cancelable}. If this event is canceled, the spell is not cast, mana is not consumed, and the
* spell casting is interrupted. Cancelling this event on the client side will stop particles being spawned, but
* will not interrupt spell casting.<br>
* spell casting is interrupted. Cancelling this event on the client side only will stop particles being spawned, but
* will not interrupt spell casting. Cancelling this event on the server side only may have different results
* depending on the source of the spell; as such it is recommended that this event is cancelled on both sides. <br>
* <br>
* This event does not have a result. {@link HasResult}<br>
* <br>
@@ -129,8 +217,13 @@ public abstract class SpellCastEvent extends LivingEvent {
private final int count;
public Tick(EntityLivingBase caster, Spell spell, SpellModifiers modifiers, Source source, int count){
super(caster, spell, modifiers, source);
public Tick(Source source, Spell spell, EntityLivingBase caster, SpellModifiers modifiers, int count){
super(source, spell, caster, modifiers);
this.count = count;
}
public Tick(Source source, Spell spell, World world, double x, double y, double z, EnumFacing direction, SpellModifiers modifiers, int count){
super(source, spell, world, x, y, z, direction, modifiers);
this.count = count;
}
@@ -141,4 +234,39 @@ public abstract class SpellCastEvent extends LivingEvent {
}
/**
* SpellCastEvent.Finish is fired just after a continuous spell stops being cast. Use this event for anything
* that needs to know the total time for which a continuous spell has been cast, or should only happen when the
* spell finishes (as opposed to just after it starts, as in {@link Post}).<br>
* <br>
* This event is not {@link Cancelable}.<br>
* <br>
* This event does not have a result. {@link HasResult}<br>
* <br>
* This event is fired on the {@link MinecraftForge#EVENT_BUS}.
*
* @author Electroblob
* @since Wizardry 2.1
*/
public static class Finish extends SpellCastEvent {
private final int count;
public Finish(Source source, Spell spell, EntityLivingBase caster, SpellModifiers modifiers, int count){
super(source, spell, caster, modifiers);
this.count = count;
}
public Finish(Source source, Spell spell, World world, double x, double y, double z, EnumFacing direction, SpellModifiers modifiers, int count){
super(source, spell, world, x, y, z, direction, modifiers);
this.count = count;
}
/** Returns the total number of ticks this (continuous) spell was cast for. */
public int getCount(){
return count;
}
}
}