net.risingworld.api.utils

Class Definitions.ObjectDefinition

java.lang.Object

net.risingworld.api.utils.Definitions.ObjectDefinition

Enclosing class:

Definitions

public static class Definitions.ObjectDefinition
extends java.lang.Object

A class representing object definitions ("meta data").

Method Summary

Modifier and Type	Method and Description
short	getID() Gets the object ID.
java.lang.String	getName() Gets the object name (alway lowercase).
java.lang.String	getRelatedItem() Gets the related item of this object (always lowercase).
GameImageInformation	getTexture(int number, int variation) This method gets a reference to the object texture.
int	getTextureCount(int variation) Gets the total amount of used textures for this object, or more precisely, for a particular object variation.
java.lang.String	getType() Gets the object type as String (always uppercase).
int	getVariationCount() Gets the amount of available variations for this object.
boolean	hasCollision() Gets whether or not this object has collision.
boolean	isChest() Gets whether or not this object is a chest.
boolean	isDoor() Gets whether or not this object is a door (or something similar, like a drawbridge).
boolean	isFurnace() Gets whether or not this object is a furnace.
boolean	isPickupable() Gets whether or not this object can be picked up by the player.
boolean	isSign() Gets whether or not this object is a sign.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public short getID()

Gets the object ID.

Returns:

the object ID.

getName

public java.lang.String getName()

Gets the object name (alway lowercase). This is the same name that is used for console commands (e.g. "table").

Returns:

the object name.

getType

public java.lang.String getType()

Gets the object type as String (always uppercase). Valid object types: DEFAULT, DOOR, DRAWBRIDGE, FAN, CHEST, FURNACE, SIGN, GRAMOPHONE, GRINDER, TANNINGRACK, FIREPLACE, TORCHMOUNT, TRASHCAN

Returns:

the object type as String.

Example: Check if object placed by player is a chest

1	@EventMethod
2	public void onObjectPlace(PlayerPlaceObjectEvent event){
3	//Get the object id
4	short objectID = event.getObjectID();
5
6	//Get the according object definition
7	Definition def = Object.getObjectDefinition(objectID);
8
9	//Now check if the object is a chest (object type "CHEST")
10	if(def.getObjectType().equals("CHEST")){
11	//Object is a chest! The chest id is usually stored in the "objectInfoID"
12	int chestID = event.getObjectInfoID();
13	}
14	}

hasCollision

public boolean hasCollision()

Gets whether or not this object has collision. If this object has no collision, players and NPC are able to walk "through it".

Returns:

true if this object has collision, false if not.

getVariationCount

public int getVariationCount()

Gets the amount of available variations for this object.

Returns:

the amount of available variations.

getRelatedItem

public java.lang.String getRelatedItem()

Gets the related item of this object (always lowercase). Returns null if this object has no related item.

Returns:

the related item name.

isPickupable

public boolean isPickupable()

Gets whether or not this object can be picked up by the player.

Returns:

true if the object can be picked up (deconstructed), false if not.

isChest

public boolean isChest()

Gets whether or not this object is a chest.

Returns:

true if this object is a chest, false if not.

isFurnace

public boolean isFurnace()

Gets whether or not this object is a furnace.

Returns:

true if this object is a furnace, false if not.

isDoor

public boolean isDoor()

Gets whether or not this object is a door (or something similar, like a drawbridge).

Returns:

true if this object is a door/drawbridge, false if not.

isSign

public boolean isSign()

Gets whether or not this object is a sign.

Returns:

true if this object is a sign, false if not.

getTexture

public GameImageInformation getTexture(int number,
                                       int variation)

This method gets a reference to the object texture. Note that every object has up to five different textures (for every mesh part).

Parameters:

number - the texture number (0-4). Use getTextureCount(int) to find out the total amount of textures of a particular variation.

variation - the object variation. Default variation is 0.

Returns:

a GameImageInformation object representing the object texture. This can be used as texture for GuiImage or World3DModel objects, for example.

See Also:

getTextureCount(int)

getTextureCount

public int getTextureCount(int variation)

Gets the total amount of used textures for this object, or more precisely, for a particular object variation.

Parameters:

variation - the object variation. Default variation is 0.

Returns:

the total amount of textures of this object (1-5).