net.risingworld.api.objects

Interface Npc

public interface Npc

Represents an npc, i.e. animals, humans, monsters etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Npc.Type Determines the npc type, i.e. if it's an animal, human etc.

Method Summary

Modifier and Type	Method and Description
void	deleteAttribute(java.lang.String key) Removes an attribute from this area.
int	getAge() Gets the "age" of the npc in seconds, i.e. how many seconds passed since the npc was spawned.
java.lang.Object	getAttribute(java.lang.String key) Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.
Clothes	getClothes() Gets a Clothes object which contains the clothes the npc is currently wearing.
Definitions.NpcDefinition	getDefinition()
int	getGlobalID() Gets the unique ID of the npc.
int	getGroupID() Gets the "group" ID of the npc.
int	getHealth() Gets the current health of the npc.
Player	getHostilePlayer() Gets the "hostile player".
int	getHunger() Gets the current hunger level of the npc. 100 means the npc is not hungry, 0 means the npc is starving.
int	getInfoID() Gets the info ID of the npc.
java.lang.String	getName() Gets the name of the npc.
Player	getNearestPlayer() Gets the nearest player, or more precisely, the player which is considered as the "nearest player" by the npc.
Vector3f	getPosition() Gets a Vector3f containing the current global x, y and z coordinate of the npc.
java.lang.Object	getRider() Gets the rider of the npc, if present.
Quaternion	getRotation()
Skin	getSkin() Gets a Skin object which represents the appearance of the npc, i.e. gender, haircut, skin color, hair color etc.
int	getThirst() Gets the current thirst level of the npc. 100 means the npc is not thirsty, 0 means the npc is dying of dehydration.
Npc.Type	getType() Gets the type of this npc (i.e. the species/kind).
int	getTypeID() Gets the type ID of the npc.
int	getVariation() Gets the variation of the npc.
Vector3f	getVectorToNearestPlayer() Gets a normalized vector from the npc position to the position of the nearest player.
Vector3f	getViewDirection() Gets the current view direction of the npc as a normalized vector.
boolean	hasAttribute(java.lang.String key) Gets whether or not the provided attribute exists.
boolean	isAlerted() Gets whether or not the npc is currently alerted/alarmed.
boolean	isDead() Gets whether or not the npc is dead.
boolean	isInLava() Gets whether the npc is currently in lava or not.
boolean	isInvincible() Gets whether or not the npc is invincible, this means it cannot be killed by any players or other npcs.
boolean	isInWater() Gets whether the npc is currently in water or not.
boolean	isLocked() Gets whether or not the npc is currently "locked".
boolean	isSleeping() Gets whether or not the npc is currently sleeping.
boolean	isTransient() Gets whether the npc is 'transient' or not.
boolean	isUnderWater() Gets whether the npc is currently under water or not.
void	kill() Kills the npc instantly.
void	moveTo(float x, float y, float z) Moves the npc to the provided position, i.e. the npc will walk to this position.
void	moveTo(Vector3f position) Moves the npc to the provided position, i.e. the npc will walk to this position.
void	setAge(int age) Sets the "age" of the npc.
void	setAlerted(boolean set) Changes the "alert" state of the npc.
void	setAlerted(boolean set, int duration) Changes the "alert" state of the npc.
void	setAttribute(java.lang.String key, java.lang.Object value) Stores an attribute for this area.
void	setGroupID(int groupID) Sets the "group" ID for the npc.
void	setHealth(int health) Sets the health of the npc.
void	setHunger(int hunger) Sets the hunger level of the npc. 100 means the npc is not hungry, 0 means the npc is starving.
void	setInvincible(boolean set) Enables/disables invincibility for this npc.
void	setLocked(boolean set) Locks or unlocks the npc.
void	setName(java.lang.String name) Sets the name of this npc.
void	setPosition(float x, float y, float z) Sets the global position of the npc (teleports the npc).
void	setPosition(Vector3f position) Sets the global position of the npc (teleports the npc).
void	setRotation(float pitch, float yaw, float roll)
void	setRotation(Quaternion quaternion)
void	setThirst(int thirst) Sets the thirst level of the npc. 100 means the npc is not thirsty, 0 means the npc is dying of dehydration.
void	setViewDirection(float dirx, float diry, float dirz) Sets the view direction of the npc.
void	setViewDirection(Vector3f direction) Sets the view direction of the npc.
void	transform(int typeID, int variation)

Method Detail

getType

Npc.Type getType()

Gets the type of this npc (i.e. the species/kind). Not to be confused with getTypeID()!

Returns:

the npc type (species/kind).

Example: Check if the npc is a human

1	Npc npc = world.getNpc(...);
2	if(npc.getType() == Type.Human){
3	System.out.println("NPC is a human!");
4	}

getGlobalID

int getGlobalID()

Gets the unique ID of the npc.

Returns:

the unique ID of npc.

getTypeID

int getTypeID()

Gets the type ID of the npc. Not to be confused with the Npc.Type!

Returns:

the type ID of the npc (i.e. the internal ID of the npc in the definitions table. For example, pigs have ID 1, cows have ID 2 etc).

Example: Check if two npc's are the same race (e.g. npc1 and npc2 are cows)

1	Npc npc1 = world.getNpc(...);
2	Npc npc2 = world.getNpc(...);
3	if(npc1.getTypeID() == npc2.getTypeID()){
4	System.out.println("NPC 1 and NPC 2 are the same race!");
5	}

getVariation

int getVariation()

Gets the variation of the npc. By default it's 0. Only certain npc can have different variations.

Returns:

the variation of the npc.

getGroupID

int getGroupID()

Gets the "group" ID of the npc. A group is basically a herd or a squad. Only certain npc are member of a group/squad/herd (e.g. bandits).
If a group member is alerted, all other group members will be alerted too (unless they're too far away).

Returns:

the group ID of the npc. -1 if no group is set.

setGroupID

void setGroupID(int groupID)

Sets the "group" ID for the npc. A group is basically a herd or a squad.
If a group member is alerted, all other group members will be alerted too (unless they're too far away).
To get an unused group ID, you can call World.getNextNpcGroupID().

Parameters:

groupID - the group ID for the npc. Set -1 to set the group to "none"

See Also:

World.getNextNpcGroupID()

isTransient

boolean isTransient()

Gets whether the npc is 'transient' or not. If it is transient, it will not be stored in the database (i.e. it is basically a temporary npc which will disappear after server restart).

Returns:

true if the npc is transient, false if not.

getName

java.lang.String getName()

Gets the name of the npc. This name is optional and is usually set manually by the player.

Returns:

the optional npc name.

setName

void setName(java.lang.String name)

Sets the name of this npc. The name will be displayed as nametag for other players above the npc. Setting a name for npcs is optional.

Parameters:

name - the name you want to set for the npc.

getAge

int getAge()

Gets the "age" of the npc in seconds, i.e. how many seconds passed since the npc was spawned. Some npcs only live for a certain amount of time.

Returns:

the age of the npc (in seconds).

Example: Kill npc if it's older than 2 hours

1	//Get current age of the npc, in seconds
2	int age = npc.getAge();
3
4	//2 hours == 120 minutes == 7200 seconds
5	if(age > (2 * 60 * 60)){
6	npc.kill();
7	}

setAge

void setAge(int age)

Sets the "age" of the npc. The age describes how many seconds the npc is already alive (i.e. how many seconds passed since the npc was spawned).

Parameters:

age - the new age, in seconds.

getInfoID

int getInfoID()

Gets the info ID of the npc. For most npc the info ID is usually 0 or -1, only certain npc actually use the info ID. For example, if there is a chest assigned to this npc (e.g. saddle bags), the info ID holds the particular chest ID etc.

If the npc dies, the info ID usually refers to the temporary "Chest" object which represents the dead npc corpse. If you try to get the related chest object, make sure to check for null since this chest can be removed (or despawn) at any time.

Returns:

the npc info ID.

getNearestPlayer

Player getNearestPlayer()

Gets the nearest player, or more precisely, the player which is considered as the "nearest player" by the npc.

Returns:

the nearest player, or null if no player is in proximity of the npc.

getHostilePlayer

Player getHostilePlayer()

Gets the "hostile player". For example, once a player attacks the npc, he's usually considered as "hostile" by the npc, so the npc either attacks the player or tries to escape. Once the distance between the player and the npc is far enough, the "hostile player" will be reset (so the player is no longer considered as hostile).

Returns:

the "hostile player" (see above), or null if there is currently no hostile player.

isLocked

boolean isLocked()

Gets whether or not the npc is currently "locked". If an npc is locked, it will never move away nor attack the player. Basically it stands still at the current location (although it can still fall down if spawned in the air, for example).

Returns:

true if the npc is "locked", false if not.

setLocked

void setLocked(boolean set)

Locks or unlocks the npc. If an npc is locked, it will never move away nor attack the player. Basically it stands still at the current location (although it can still fall down if spawned in the air, for example).
This setting gets saved to the npc database, so it's still active after a server restart.

Parameters:

set - true to lock the npc (so it will never move away), false to unlock it (default behavior).

isInvincible

boolean isInvincible()

Gets whether or not the npc is invincible, this means it cannot be killed by any players or other npcs.

Returns:

true if the npc is invincible, false if not (default).

setInvincible

void setInvincible(boolean set)

Enables/disables invincibility for this npc. If the npc is invincible, it cannot be killed by any players or other npcs.
This setting gets saved to the npc database, so it's still active after a server restart.

Parameters:

set - true to make this npc invincible, false to set it back to default behavior.

getRider

java.lang.Object getRider()

Gets the rider of the npc, if present. This only works for "Mounts", i.e. if npc.getType() == Type.Mount. If there is no rider (or if the npc cannot be used as mount), this function returns null.

Returns:

the rider of this npc (e.g. a Player, if present.

See Also:

Player.getMount()

Example: Check if a player is riding on this npc

1	//Get the rider object (which can be null)
2	Object rider = npc.getRider();
3
4	//Check if there is a rider at all
5	if(rider != null){
6	//Now check if it's actually a player
7	if(rider instanceof Player){
8	//Cast to "Player" object
9	Player player = (Player) rider;
10
11	//Do something...
12	System.out.println("Player "+player.getName()+" is riding this npc!");
13	}
14	}

transform

void transform(int typeID,
               int variation)

getDefinition

Definitions.NpcDefinition getDefinition()

getPosition

Vector3f getPosition()

Gets a Vector3f containing the current global x, y and z coordinate of the npc.

Returns:

the global npc position as a Vector3f (float).

setPosition

void setPosition(Vector3f position)

Sets the global position of the npc (teleports the npc).

Parameters:

position - A Vector3f (float) containing the global target position.

setPosition

void setPosition(float x,
                 float y,
                 float z)

Sets the global position of the npc (teleports the npc).

Parameters:

x - global X coordinate to set (horizontally).

y - global Y coordinate to set (vertically).

z - global Z coordinate to set (horizontally).

moveTo

void moveTo(Vector3f position)

Moves the npc to the provided position, i.e. the npc will walk to this position.

Parameters:

position - the target position.

moveTo

void moveTo(float x,
            float y,
            float z)

Moves the npc to the provided position, i.e. the npc will walk to this position.

Parameters:

x - the target position X coordinate.

y - the target position Y coordinate.

z - the target position Z coordinate.

getRotation

Quaternion getRotation()

setRotation

void setRotation(Quaternion quaternion)

setRotation

void setRotation(float pitch,
                 float yaw,
                 float roll)

getViewDirection

Vector3f getViewDirection()

Gets the current view direction of the npc as a normalized vector.

Returns:

the view direction as a Vector3f (float).

setViewDirection

void setViewDirection(Vector3f direction)

Sets the view direction of the npc. You can use this function to force the npc to look into a certain direction.

Parameters:

direction - the new view direction as a Vector3f (float). Make sure to use a unit/normalized vector.

setViewDirection

void setViewDirection(float dirx,
                      float diry,
                      float dirz)

Sets the view direction of the npc. You can use this function to force the npc to look into a certain direction.

Parameters:

dirx - X component of the new view direction vector.

diry - Y component of the new view direction vector.

dirz - Z component of the new view direction vector.

getVectorToNearestPlayer

Vector3f getVectorToNearestPlayer()

Gets a normalized vector from the npc position to the position of the nearest player. If there is no player, null is returned.

Returns:

a vector from the npc position to the position of the nearest player (as an unit/normalized vector).

isInWater

boolean isInWater()

Gets whether the npc is currently in water or not.

Returns:

true if the npc is in water, false if not.

isUnderWater

boolean isUnderWater()

Gets whether the npc is currently under water or not.

Returns:

true if the npc is under water, false if not.

isInLava

boolean isInLava()

Gets whether the npc is currently in lava or not.

Returns:

true if the npc is in lava, false if not.

setAlerted

void setAlerted(boolean set)

Changes the "alert" state of the npc. If an npc is alerted/alarmed, it starts running, and if a player is in his proximity, it will either attack the player (if it's a hostile animal) or flee from him. Setting the alert state of an npc to true, this state will last for around 20 seconds.
In combination with the moveTo(net.risingworld.api.utils.Vector3f) method, this method can be used to force the npc to run.

Please keep in mind that the game may always override the alert state.

Parameters:

set - true to set the npc alerted/alarmed, false to disable the alert state.

setAlerted

void setAlerted(boolean set,
                int duration)

Changes the "alert" state of the npc. If an npc is alerted/alarmed, it starts running, and if a player is in his proximity, it will either attack the player (if it's a hostile animal) or flee from him. By setting the duration parameter, you can determine how long the npc will stay alerted.

Please keep in mind that the game may always override the alert state or the alert duration.

Parameters:

set - true to set the npc alerted/alarmed, false to disable the alert state.

duration - the duration (in seconds) how long the npc will stay alerted. Does nothing when setting the alert state to false.

isAlerted

boolean isAlerted()

Gets whether or not the npc is currently alerted/alarmed.

Returns:

true if the npc is alerted, false if not.

getHealth

int getHealth()

Gets the current health of the npc.

Returns:

the current health of the npc.

setHealth

void setHealth(int health)

Sets the health of the npc.

Parameters:

health - the new npc health.

getHunger

int getHunger()

Gets the current hunger level of the npc. 100 means the npc is not hungry, 0 means the npc is starving.

Returns:

the current hunger level of the npc.

setHunger

void setHunger(int hunger)

Sets the hunger level of the npc. 100 means the npc is not hungry, 0 means the npc is starving.

Parameters:

hunger - the new hunger level.

getThirst

int getThirst()

Gets the current thirst level of the npc. 100 means the npc is not thirsty, 0 means the npc is dying of dehydration.

Returns:

the current thirst level of the npc.

setThirst

void setThirst(int thirst)

Sets the thirst level of the npc. 100 means the npc is not thirsty, 0 means the npc is dying of dehydration.

Parameters:

thirst - the new thirst level.

isSleeping

boolean isSleeping()

Gets whether or not the npc is currently sleeping.

Returns:

true if the npc is sleeping, false if not.

isDead

boolean isDead()

Gets whether or not the npc is dead.

Returns:

true if the npc is dead, false if not.

kill

void kill()

Kills the npc instantly.

getSkin

Skin getSkin()

Gets a Skin object which represents the appearance of the npc, i.e. gender, haircut, skin color, hair color etc.
Only certain npc have a skin object (e.g. humans)!

Returns:

a Skin object representing the visual appearance of the npc. Returns null if this npc has no skin object.

getClothes

Clothes getClothes()

Gets a Clothes object which contains the clothes the npc is currently wearing.
Only certain npc have a clothes object! Human npc can wear the same clothes as the player, while other npc can only wear certain clothes (like mounts, which can only wear saddle clothes) or no clothes at all (e.g. animals).

Returns:

a Clothes object representing the clothes of the npc. Returns null if this npc has no clothes (or if the npc cannot wear clothes).

setAttribute

void setAttribute(java.lang.String key,
                  java.lang.Object value)

Stores an attribute for this area. You can store any type of object. Note that all attributes will be reset upon server restart.

Parameters:

key - the name of the attribute.

value - the value/object you want to store.

getAttribute

java.lang.Object getAttribute(java.lang.String key)

Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.

Parameters:

key - the name of the attribute.

Returns:

the attribute that is stored for that key, or null of the key does not exists.

hasAttribute

boolean hasAttribute(java.lang.String key)

Gets whether or not the provided attribute exists.

Parameters:

key - the name of the attribute.

Returns:

true if the attribute exists, false if not.

deleteAttribute

void deleteAttribute(java.lang.String key)

Removes an attribute from this area. Does nothing if the attribute doesn't exist.

Parameters:

key - the name of the attribute you want to delete.