net.risingworld.api.utils

Class RayCastResult

java.lang.Object

net.risingworld.api.utils.RayCastResult

public class RayCastResult
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RayCastResult() Creates an "empty" RayCastResult (i.e. no collisions).
RayCastResult(int type, int info, float distance, Vector3f collisionPoint, Vector3f collisionNormal, Vector3f elementPosition, short elementTypeID)

Method Summary

Modifier and Type	Method and Description
int	getCollisionInfo() Gets the collision info id.
Vector3f	getCollisionNormal() Gets the collision normal, i.e. the normal of the surface the ray hit.
java.lang.Object	getCollisionObject() Gets the collision object, i.e. the object the ray collided with.
Vector3f	getCollisionPoint() Gets the collision point, i.e. the location where the ray hit an object.
int	getCollisionType() Gets the collision type.
float	getDistance() Gets the distance between the player (or more precisely, the origin of the ray) and the collision point.
Vector3f	getElementPosition() Gets the actual world position of the element.
short	getElementTypeID() Gets the element type id (of the element the ray collided with).
boolean	hasCollision() Gets whether or not a collision occurred.
java.lang.String	toString() Gets a String representation of this RayCastResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

RayCastResult

public RayCastResult()

Creates an "empty" RayCastResult (i.e. no collisions).

RayCastResult

public RayCastResult(int type,
                     int info,
                     float distance,
                     Vector3f collisionPoint,
                     Vector3f collisionNormal,
                     Vector3f elementPosition,
                     short elementTypeID)

Method Detail

hasCollision

public boolean hasCollision()

Gets whether or not a collision occurred. Usually it is not necessary to call this method, since in case that no collision occurred, there wouldn't be a RayCastResult object (i.e. the callback result would be null).

Returns:

true if this object holds a result, false if not.

getCollisionType

public int getCollisionType()

Gets the collision type. If no collision occurred, this methods returns 0.

Returns:

the collision type.

See Also:

CollisionType

Example: Check collision type

1	// get RayCastResult object (usually from a callback)
2	RayCastResult result = ...;
3
4	// now check the collision type (see all types in "CollisionType" class)
5	if(result.getCollisionType() == CollisionType.TERRAIN){
6	System.out.println("Collision type terrain!");
7	}
8	else if(result.getCollisionType() == CollisionType.BLOCKS){
9	System.out.println("Collision type blocks!");
10	}
11	else if(result.getCollisionType() == CollisionType.WATER){
12	System.out.println("Collision type water!");
13	}

getCollisionObject

public java.lang.Object getCollisionObject()

Gets the collision object, i.e. the object the ray collided with. Currently (as of 0.8.2.4) this only works with players and npcs (type-casting is required, check getCollisionType() first).

Returns:

the collision object, or null if no collision object was found.

Example: Get NPC

1	//perform raycast (collision type: npcs only)
2	player.raycast(CollisionType.NPCS, (RayCastResult result) -> {
3	//if result is null, no collision was found
4	if(result != null){
5	Object obj = result.getCollisionObject();
6	//it's preferable to check if obj isn't null, maybe also check the object type,
7	//just to make assurance doubly sure
8	if(obj != null && obj instanceof Npc){
9	//type-cast to Npc in this case
10	Npc npc = (Npc) obj;
11
12	//now you can access the particular npc
13	System.out.println("Npc found: " + npc.getName());
14	}
15	}
16	});

getCollisionInfo

public int getCollisionInfo()

Gets the collision info id. Usually this only applies to elements which have a global ID, e.g. npc, players, items etc.

Returns:

the collision element info id, or -1 if this element has no info id (or if no collision occurred).

getCollisionPoint

public Vector3f getCollisionPoint()

Gets the collision point, i.e. the location where the ray hit an object.
Note: If you want to get the actual world position of the hit object instead, see getElementPosition()

Returns:

the collision position as a Vector3f, or null if no collision occurred.

getCollisionNormal

public Vector3f getCollisionNormal()

Gets the collision normal, i.e. the normal of the surface the ray hit.
This normal is already normalized.

Returns:

the collision normal as a normalized Vector3f, or null if no collision occurred.

getElementPosition

public Vector3f getElementPosition()

Gets the actual world position of the element. For example, if an object (e.g. furniture or a door) was hit by the ray, the world position of this element is returned (while getCollisionPoint() only returns the point where the ray hit the object). Having the actual element position allows you to get more information about the particular object.
Returns null if no collision occurred or if the hit object does not support this (e.g. terrain, blocks, water, grass etc).

This function works for entities like npc or players, but also for objects (furniture), plants, construction elements, API world elements and corpses.

Returns:

the actual element world position, or null if this element has no position, or if no collision occurred.

See Also:

getElementTypeID()

Example: Check if the element is an object (e.g. furniture), then remove it

1	//perform raycast (collision type: objects only)
2	player.raycast(CollisionType.OBJECTS, (RayCastResult result) -> {
3	//if result is null, no collision was found
4	if(result != null){
5	//check if a collision was found
6	if(result.hasCollision()){
7	//get the actual object world position, but check if it's not null...
8	Vector3f position = result.getElementPosition();
9	if(position != null){
10	//remove object
11	getWorld().removeObject(result.getElementTypeID(), position.x, position.y, position.z);
12	}
13	}
14	}
15	});

getElementTypeID

public short getElementTypeID()

Gets the element type id (of the element the ray collided with). This only works for elements which have a type id (e.g. objects, construction elements, plants, npc etc).

Returns:

the element type id, or -1 if no collision occurred or if the object does not have a type id (e.g. terrain, water, grass etc).

See Also:

getElementPosition()

getDistance

public float getDistance()

Gets the distance between the player (or more precisely, the origin of the ray) and the collision point. Returns Float.MAX_VALUE if no collision occurred.

Returns:

the distance to the collision point.

toString

public java.lang.String toString()

Gets a String representation of this RayCastResult.

Overrides:

toString in class java.lang.Object

Returns:

a string representing the values of this RayCastResult.