net.risingworld.api.events.player.world

Class PlayerObjectHitEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerObjectEvent

net.risingworld.api.events.player.world.PlayerObjectHitEvent

public class PlayerObjectHitEvent
extends PlayerObjectEvent

Called when a player hits an object (e.g. furniture, doors, lamps etc).

See Also:

PlayerVegetationHitEvent, PlayerConstructionHitEvent

Example: Destroy object after a single hit

1	@EventMethod
2	public void onObjectHit(PlayerObjectHitEvent event){
3	//Get the "World" object (it's needed to remove the object)
4	World world = getWorld();
5
6	//Call "removeObject()" on the "World" object. Retrieve typeID and position coordinates from the event
7	world.removeObject(event.getObjectTypeID(), event.getObjectPositionX(), event.getObjectPositionY(), event.getObjectPositionZ());
8	}

Constructor Summary

Constructors

Constructor and Description
PlayerObjectHitEvent(Player player, float hitx, float hity, float hitz, short dmg, short objectid, byte variation, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, int info, byte status)

Method Summary

Modifier and Type	Method and Description
short	getDamage() Gets the amount of damage the player causes by hitting the object.
Vector3f	getHitPosition() Gets the coordinates where the object was hit exactly.
float	getHitPositionX() Gets the x coordinate where the object was hit exactly.
float	getHitPositionY() Gets the y coordinate where the object was hit exactly.
float	getHitPositionZ() Gets the z coordinate where the object was hit exactly.

Methods inherited from class net.risingworld.api.events.player.world.PlayerObjectEvent

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getObjectDefinition, getObjectInfoID, getObjectPosition, getObjectPositionX, getObjectPositionY, getObjectPositionZ, getObjectRotation, getObjectRotationX, getObjectRotationY, getObjectRotationZ, getObjectStatus, getObjectTypeID, getObjectVariation, getPX, getPY, getPZ, getRX, getRY, getRZ

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerObjectHitEvent

public PlayerObjectHitEvent(Player player,
                            float hitx,
                            float hity,
                            float hitz,
                            short dmg,
                            short objectid,
                            byte variation,
                            int cx,
                            int cy,
                            int cz,
                            short px,
                            short py,
                            short pz,
                            short rx,
                            short ry,
                            short rz,
                            int info,
                            byte status)

Method Detail

getDamage

public short getDamage()

Gets the amount of damage the player causes by hitting the object.

Returns:

the amount of damage dealt with this hit.

getHitPosition

public Vector3f getHitPosition()

Gets the coordinates where the object was hit exactly.

Returns:

coordinates where the object was hit.

getHitPositionX

public float getHitPositionX()

Gets the x coordinate where the object was hit exactly.

Returns:

x coordinate where the object was hit.

getHitPositionY

public float getHitPositionY()

Gets the y coordinate where the object was hit exactly.

Returns:

y coordinate where the object was hit.

getHitPositionZ

public float getHitPositionZ()

Gets the z coordinate where the object was hit exactly.

Returns:

z coordinate where the object was hit.