Added some documentation to a few interfaces for the javadoc.

This commit is contained in:
Luis C.M committed 2022-05-17 05:24:57 -05:00
1 parent 648206f5ba
commit fd1aa40456
4 files changed
+111 -11

No files matched your search

@@ -9,15 +9,31 @@ import net.minecraft.util.DamageSource;
import noppes.npcs.scripted.interfaces.entity.IEntity;
public interface IDamageSource {
/**
*
* @return Returns the damage type of the damage source as a string. Ex: "lava", "explosion", "magic", "outOfWorld", etc.
*/
String getType();
boolean isUnblockable();
boolean isProjectile();
/**
*
* @return Returns the entity source of where the damage source originated. If a player was shot by an arrow from a skeleton, this would return an IEntity object of the skeleton.
*/
IEntity getTrueSource();
/**
*
* @return Returns the entity source of where the damage source originated. If a player was shot by an arrow from a skeleton, this would return an IEntity object of the arrow.
*/
IEntity getImmediateSource();
/**
*
* @return Returns a non-script, obfuscated MC damage source object.
*/
DamageSource getMCDamageSource();
}