net.risingworld.api.events.player.world

Class PlayerVegetationHitEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerVegetationEvent

net.risingworld.api.events.player.world.PlayerVegetationHitEvent

public class PlayerVegetationHitEvent
extends PlayerVegetationEvent

Called when a player hits a plant (e.g. a tree, bush, flowers etc).

See Also:

PlayerObjectHitEvent, PlayerConstructionHitEvent

Example: Randomly spawn an apple when player hits a tree

1	@EventMethod
2	public void onVegetationHit(PlayerVegetationHitEvent event){
3	//Get the "World" object (it's needed to spawn an item)
4	World world = getWorld();
5
6	//First we need the plant definition to find out if the plant is an adult tree
7	Definitions.PlantDefinition plantDef = event.getPlantDefinition();
8
9	//Check if plant is a tree and if it cannot grow (so it's an adult tree)
10	if(plantDef.isTree() && !plantDef.isGrowable()){
11	//We want a 50% chance that an apple spawns. To get a random value efficiently,
12	//you can use the Utils.MathUtils class. For a ~ 50% chance, just get a random boolean:
13	if(Utils.MathUtils.nextRandomBoolean()){
14	//You can use ItemDefinitions to get the internal type id of an apple
15	Definitions.ItemDefinition itemDef = Definitions.getItemDefinition("apple");
16
17	//Spawn "physical" apple at the "hit position" (where the pickaxe hits the tree)
18	world.spawnItem(itemDef.getID(), 0, 1, event.getHitPosition(), Quaternion.IDENTITY, true);
19	}
20	}
21	}

Constructor Summary

Constructors

Constructor and Description
PlayerVegetationHitEvent(Player player, float hitx, float hity, float hitz, short dmg, short plantid, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, boolean iscut)

Method Summary

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

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

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getPlantDefinition, getPlantPosition, getPlantPositionX, getPlantPositionY, getPlantPositionZ, getPlantRotation, getPlantRotationX, getPlantRotationY, getPlantRotationZ, getPlantTypeID, 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

PlayerVegetationHitEvent

public PlayerVegetationHitEvent(Player player,
                                float hitx,
                                float hity,
                                float hitz,
                                short dmg,
                                short plantid,
                                int cx,
                                int cy,
                                int cz,
                                short px,
                                short py,
                                short pz,
                                short rx,
                                short ry,
                                short rz,
                                boolean iscut)

Method Detail

getDamage

public short getDamage()

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

Returns:

the amount of damage dealt with this hit.

getHitPosition

public Vector3f getHitPosition()

Gets the coordinates where the plant was hit exactly.

Returns:

coordinates where the plant was hit.

getHitPositionX

public float getHitPositionX()

Gets the x coordinate where the plant was hit exactly.

Returns:

x coordinate where the plant was hit.

getHitPositionY

public float getHitPositionY()

Gets the y coordinate where the plant was hit exactly.

Returns:

y coordinate where the plant was hit.

getHitPositionZ

public float getHitPositionZ()

Gets the z coordinate where the plant was hit exactly.

Returns:

z coordinate where the plant was hit.