net.risingworld.api.worldelements

Class WorldElement

java.lang.Object

net.risingworld.api.worldelements.WorldElement

Direct Known Subclasses:

World3DModel, World3DText, WorldArea

public abstract class WorldElement
extends java.lang.Object

Abstract base class for all static elements in the game world.

Method Summary

Modifier and Type	Method and Description
void	deleteAttribute(java.lang.String key) Removes an attribute from this element.
void	destroy() Destroys this element, i.e. remove it from all players.
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.
int	getID() Gets the id of this element.
Vector3f	getPosition() Gets the global position of this element.
Quaternion	getRotation() Gets the rotation of this element.
float	getVisibleRange() Gets the max distance the element will still be visible.
boolean	hasAttribute(java.lang.String key) Gets whether or not the provided attribute exists.
void	moveTo(float x, float y, float z, float speed) Moves the element (smoothly) to the target position.
void	moveTo(Vector3f position, float speed) Moves the element (smoothly) to the target position.
void	refresh() Internal use only.
void	setAttribute(java.lang.String key, java.lang.Object value) Stores an attribute for this element.
void	setPosition(float x, float y, float z) Sets the global position of this element.
void	setPosition(Vector3f position) Sets the global position of this element.
void	setRotation(float pitch, float yaw, float roll)
void	setRotation(Quaternion rotation) Sets the rotation of this element.
void	setVisibleRange(float range) Sets the max distance the element will be visible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getID

public int getID()

Gets the id of this element.
This id is unique (regarding world elements), but only during this session (i.e. after restarting the server, this element may get a different id).

Returns:

the id of this element.

setPosition

public void setPosition(Vector3f position)

Sets the global position of this element.

Parameters:

position - a vector which holds the position coordinates.

setPosition

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

Sets the global position of this element.

Parameters:

x - the global x position (horizontally).

y - the global y position (vertically).

z - the global z position (horizontally).

getPosition

public Vector3f getPosition()

Gets the global position of this element.

Returns:

a vector which holds the position coordinates of this element.

moveTo

public void moveTo(Vector3f position,
                   float speed)

Moves the element (smoothly) to the target position.

Parameters:

position - the target position.

speed - the speed (how long it should take to move the element to the target position).

moveTo

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

Moves the element (smoothly) to the target position.

Parameters:

x - the target x coordinate.

y - the target y coordinate.

z - the target z coordinate.

speed - the speed (how long it should take to move the element to the target position).

setRotation

public void setRotation(Quaternion rotation)

Sets the rotation of this element.

Parameters:

rotation - the quaternion which represents the new rotation.

setRotation

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

getRotation

public Quaternion getRotation()

Gets the rotation of this element.

Returns:

a quaternion which represents the current rotation.

setVisibleRange

public void setVisibleRange(float range)

Sets the max distance the element will be visible. If the player moves further away, the element will be culled.

Parameters:

range - the max visible range.

getVisibleRange

public float getVisibleRange()

Gets the max distance the element will still be visible.

Returns:

the max visible range.

destroy

public void destroy()

Destroys this element, i.e. remove it from all players.

setAttribute

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

Stores an attribute for this element. 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

public 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

public 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

public void deleteAttribute(java.lang.String key)

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

Parameters:

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

refresh

public void refresh()

Internal use only.