mirror of
https://github.com/KAMKEEL/CustomNPC-Plus.git
synced 2026-11-17 18:05:10 +00:00
Added plenty more documentation for the javadoc.
This commit is contained in:
1 parent
af4b467931
commit
b9266c3cc5
20 files changed
+623
-94
No files matched your search
@@ -14,45 +14,154 @@ public interface IPos {
|
||||
|
||||
int getZ();
|
||||
|
||||
/**
|
||||
* Shifts the IPos up by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos up();
|
||||
|
||||
IPos up(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position up by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos up(int n);
|
||||
|
||||
/**
|
||||
* Shifts the IPos down by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos down();
|
||||
|
||||
IPos down(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position down by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos down(int n);
|
||||
|
||||
/**
|
||||
* Shifts the IPos north by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos north();
|
||||
|
||||
IPos north(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position north by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos north(int n);
|
||||
|
||||
/**
|
||||
* Shifts the IPos east by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos east();
|
||||
|
||||
IPos east(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position east by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos east(int n);
|
||||
|
||||
/**
|
||||
* Shifts the IPos south by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos south();
|
||||
|
||||
IPos south(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position south by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos south(int n);
|
||||
|
||||
/**
|
||||
* Shifts the IPos west by 1 block and returns the new object.
|
||||
*
|
||||
*/
|
||||
IPos west();
|
||||
|
||||
IPos west(int var1);
|
||||
/**
|
||||
*
|
||||
* @param n The number of blocks to move the position west by.
|
||||
* @return The new IPos object.
|
||||
*/
|
||||
IPos west(int n);
|
||||
|
||||
IPos add(int var1, int var2, int var3);
|
||||
/**
|
||||
* Adds the IPos' coordinates by each of the parameters given.
|
||||
*
|
||||
* @param x X coordinate amount to be added
|
||||
* @param y Y coordinate amount to be added
|
||||
* @param z Z coordinate amount to be added
|
||||
* @return The resulting IPos from the addition.
|
||||
*/
|
||||
IPos add(int x, int y, int z);
|
||||
|
||||
IPos add(IPos var1);
|
||||
/**
|
||||
* Directly adds the coordinates of two IPos objects and returns the resulting IPos sum.
|
||||
* For example, if one IPos was represented by the coordinates (0,60,5), and another by (-10,-30,25),
|
||||
* the resulting object's coordinates are (0 - 10,60 - 30,5 + 25) = (-10,30,30).
|
||||
*
|
||||
* @param pos The position to be added to this IPos object.
|
||||
* @return The sum of the two IPos objects as a new IPos object.
|
||||
*/
|
||||
IPos add(IPos pos);
|
||||
|
||||
IPos subtract(int var1, int var2, int var3);
|
||||
/**
|
||||
* Subtracts the IPos' coordinates by each of the parameters given.
|
||||
*
|
||||
* @param x X coordinate amount to be subtracted
|
||||
* @param y Y coordinate amount to be subtracted
|
||||
* @param z Z coordinate amount to be subtracted
|
||||
* @return The resulting IPos from the subtraction.
|
||||
*/
|
||||
IPos subtract(int x, int y, int z);
|
||||
|
||||
IPos subtract(IPos var1);
|
||||
/**
|
||||
* Directly subtracts the coordinates of two IPos objects and returns the resulting IPos difference.
|
||||
* For example, if one IPos was represented by the coordinates (0,60,5), and another by (-10,-30,25),
|
||||
* the resulting object's coordinates are (0 + 10,60 + 30,5 - 25) = (10,90,-20).
|
||||
*
|
||||
* @param pos The position to be subtracted from this IPos object.
|
||||
* @return The difference of the two IPos objects as a new IPos object.
|
||||
*/
|
||||
IPos subtract(IPos pos);
|
||||
|
||||
/**
|
||||
* Returns a normalized vector of this block's position, calculated by:
|
||||
*
|
||||
*
|
||||
* @return The normalized vector of this block position.
|
||||
*/
|
||||
double[] normalize();
|
||||
|
||||
/**
|
||||
*
|
||||
* @return An obfuscated MC BlockPos object.
|
||||
*/
|
||||
BlockPos getMCBlockPos();
|
||||
|
||||
IPos offset(int var1);
|
||||
/**
|
||||
* Offsets the block by 1 block in the given direction and returns the resulting IPos object
|
||||
*
|
||||
*/
|
||||
IPos offset(int direction);
|
||||
|
||||
IPos offset(int var1, int var2);
|
||||
/**
|
||||
* Offsets the block by n blocks in the given direction and returns the resulting IPos object
|
||||
*
|
||||
*/
|
||||
IPos offset(int direction, int n);
|
||||
|
||||
double distanceTo(IPos var1);
|
||||
/**
|
||||
*
|
||||
* @param pos The IPos object to calculate the distance to
|
||||
* @return The distance between this IPos object and the other.
|
||||
*/
|
||||
double distanceTo(IPos pos);
|
||||
}
|
||||
Reference in new issue
Block a user