net.risingworld.api.objects

Interface WorldItem

All Superinterfaces:

Item

public interface WorldItem
extends Item

Represents an item that exists in the game world, for example an item that has been dropped by a player.

See Also:

Item

Nested Class Summary

Nested classes/interfaces inherited from interface net.risingworld.api.objects.Item

Item.Attribute, Item.ClothingAttribute, Item.CustomItemAttribute, Item.Definition, Item.ObjectAttribute

Method Summary

Modifier and Type	Method and Description
void	applyPhysicalImpulse(Vector3f impulse)
void	destroy() Destroys (i.e. despawns) this item.
int	getGlobalID() Gets the global ID if this item.
Vector3f	getPosition() Gets a Vector3f containing the current global x, y and z coordinate of this item.
Player	getRelatedPlayer() This function returns the player that is related to this item.
Quaternion	getRotation() Gets a Quaternion containing the current rotation of this item.
boolean	isDummy() Gets whether or not this item is a "dummy item".
void	setPosition(float x, float y, float z) Sets the global position of the item.
void	setPosition(Vector3f position) Sets the global position of the item.
void	setRotation(Quaternion quaternion) Sets the rotation of this item.

Methods inherited from interface net.risingworld.api.objects.Item

getAttribute, getDefinition, getItemDefinition, getItemDefinition, getMaxStacksize, getName, getStacksize, getStatus, getTypeID, getValue, getVariation

Method Detail

getGlobalID

int getGlobalID()

Gets the global ID if this item. This ID is unique, but it is only valid until the server restarts.

Returns:

the global ID of this item.

getRelatedPlayer

Player getRelatedPlayer()

This function returns the player that is related to this item. Usually this is the player who has dropped the item.

Returns:

the related player of this item, or null if no player was found.

isDummy

boolean isDummy()

Gets whether or not this item is a "dummy item". This means it has no phyiscal behaviour, but still exists in the game world, and can also be picked up. This is used for ores inside a furnace, for example.

Returns:

true if this is a "dummy item", or false if not.

destroy

void destroy()

Destroys (i.e. despawns) this item.

getPosition

Vector3f getPosition()

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

Returns:

the global item position as a Vector3f (float).

Example:

1	{@code
2	Vector3f position = item.getPosition();
3	System.out.println("Item position: "+position.getX()+" "+position.getY()+" "+position.getZ());
4	}

setPosition

void setPosition(Vector3f position)

Sets the global position of the item.

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 item.

Parameters:

x - global X coordinate to set (horizontally).

y - global Y coordinate to set (vertically).

z - global Z coordinate to set (horizontally).

getRotation

Quaternion getRotation()

Gets a Quaternion containing the current rotation of this item.

Returns:

the item rotation as a Quaternion.

setRotation

void setRotation(Quaternion quaternion)

Sets the rotation of this item.

Parameters:

quaternion - a Quaternion representing the rotation.

applyPhysicalImpulse

void applyPhysicalImpulse(Vector3f impulse)