mirror of
https://github.com/KAMKEEL/CustomNPC-Plus-API.git
synced 2026-11-16 15:24:47 +00:00
Entity API Documentation
This commit is contained in:
1 parent
3593a09d1d
commit
8c2c226d34
21 files changed
+2778
-1142
No files matched your search
@@ -1,51 +1,90 @@
|
||||
package noppes.npcs.api.entity;
|
||||
|
||||
import noppes.npcs.api.item.IItemStack;
|
||||
|
||||
public interface IProjectile {
|
||||
|
||||
public IItemStack getItem();
|
||||
|
||||
public void setItem(IItemStack item);
|
||||
|
||||
/**
|
||||
* @return Returns whether the arrow flies in a straight line or not
|
||||
*/
|
||||
public boolean getHasGravity();
|
||||
|
||||
/**
|
||||
* @param bo Whether the arrow flies in a straight line or not
|
||||
*/
|
||||
public void setHasGravity(boolean bo);
|
||||
|
||||
public int getAccuracy();
|
||||
|
||||
public void setAccuracy(int accuracy);
|
||||
|
||||
/**
|
||||
* Entity where the projectile heads towards
|
||||
* The position for the projectile needs to have been set for this
|
||||
*/
|
||||
public void setHeading(IEntity entity);
|
||||
|
||||
/**
|
||||
* Position where the projectile heads towards.
|
||||
* The position for the projectile needs to have been set for this
|
||||
*/
|
||||
public void setHeading(double x, double y, double z);
|
||||
|
||||
/**
|
||||
* @param yaw Rotation yaw
|
||||
* @param pitch Rotation pitch
|
||||
*/
|
||||
public void setHeading(float yaw, float pitch);
|
||||
|
||||
|
||||
public IEntity getThrower();
|
||||
|
||||
|
||||
/**
|
||||
* For scripters to enable projectile events in their current scripting container
|
||||
*/
|
||||
public void enableEvents();
|
||||
}
|
||||
package noppes.npcs.api.entity;
|
||||
|
||||
import noppes.npcs.api.item.IItemStack;
|
||||
|
||||
/**
|
||||
* Represents a projectile entity.
|
||||
* Provides methods to access and modify the projectile's item, gravity, accuracy, heading,
|
||||
* and to enable scripting events.
|
||||
*/
|
||||
public interface IProjectile {
|
||||
|
||||
/**
|
||||
* Returns the item associated with the projectile (e.g. arrow, fireball).
|
||||
*
|
||||
* @return the item as an IItemStack.
|
||||
*/
|
||||
IItemStack getItem();
|
||||
|
||||
/**
|
||||
* Sets the item for the projectile.
|
||||
*
|
||||
* @param item the item to set.
|
||||
*/
|
||||
void setItem(IItemStack item);
|
||||
|
||||
/**
|
||||
* @return true if the projectile is affected by gravity; false if it flies straight.
|
||||
*/
|
||||
boolean getHasGravity();
|
||||
|
||||
/**
|
||||
* Sets whether the projectile is affected by gravity.
|
||||
*
|
||||
* @param bo true to enable gravity; false otherwise.
|
||||
*/
|
||||
void setHasGravity(boolean bo);
|
||||
|
||||
/**
|
||||
* Returns the accuracy value for the projectile.
|
||||
*
|
||||
* @return the accuracy.
|
||||
*/
|
||||
int getAccuracy();
|
||||
|
||||
/**
|
||||
* Sets the accuracy value for the projectile.
|
||||
*
|
||||
* @param accuracy the accuracy value.
|
||||
*/
|
||||
void setAccuracy(int accuracy);
|
||||
|
||||
/**
|
||||
* Sets the heading (target destination) for the projectile based on the target entity.
|
||||
* The projectile's position should already be set.
|
||||
*
|
||||
* @param entity the target entity.
|
||||
*/
|
||||
void setHeading(IEntity entity);
|
||||
|
||||
/**
|
||||
* Sets the heading for the projectile to the specified coordinates.
|
||||
* The projectile's position should already be set.
|
||||
*
|
||||
* @param x the target x coordinate.
|
||||
* @param y the target y coordinate.
|
||||
* @param z the target z coordinate.
|
||||
*/
|
||||
void setHeading(double x, double y, double z);
|
||||
|
||||
/**
|
||||
* Sets the heading using yaw and pitch values.
|
||||
*
|
||||
* @param yaw the yaw angle.
|
||||
* @param pitch the pitch angle.
|
||||
*/
|
||||
void setHeading(float yaw, float pitch);
|
||||
|
||||
/**
|
||||
* Returns the thrower (the entity that launched the projectile).
|
||||
*
|
||||
* @return the thrower as an IEntity.
|
||||
*/
|
||||
IEntity getThrower();
|
||||
|
||||
/**
|
||||
* Enables projectile events for the current scripting container.
|
||||
* Must be called during a script.
|
||||
**/
|
||||
void enableEvents();
|
||||
}
|
||||
Reference in new issue
Block a user