Package net.risingworld.api.events.world

Class ProjectileFireEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.world.ProjectileFireEvent

All Implemented Interfaces:

Cancellable

public final class ProjectileFireEvent
extends Event
implements Cancellable

Called when a projectile was fired.

See Also:

• ProjectileHitEvent
• PlayerWeaponFireEvent

Field Summary

Fields inherited from class net.risingworld.api.events.Event

cancelled, pointer

Method Summary

Modifier and Type	Method	Description
Vector3f	getDirection()	Gets the direction of the projectile.
Vector3f	getPosition()	Gets the global world position where the projectile was launched.
Items.ProjectileDefinition	getProjectileDefinition()	Gets the definition of the projectile that was fired.
boolean	isCancelled()	Determines if the event is cancelled.
void	setCancelled(boolean cancel)	Cancels this event.
void	setDirection(float x, float y, float z)	Changes the direction of the projectile.
void	setDirection(Vector3f direction)	Changes the direction of the projectile.
void	setPosition(float x, float y, float z)	Changes the global world position of the projectile.
void	setPosition(Vector3f position)	Changes the global world position of the projectile.

Methods inherited from class net.risingworld.api.events.Event

equals, hashCode, isValid

Methods inherited from class java.lang.Object

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

Method Details

getPosition

public Vector3f getPosition()

Gets the global world position where the projectile was launched.

Returns:

the global position, as a Vector3f.

setPosition

public void setPosition(Vector3f position)

Changes the global world position of the projectile.

Parameters:

position - the new position.

setPosition

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

Changes the global world position of the projectile.

Parameters:

x - the new x position.

y - the new y position.

z - the new z position.

getDirection

public Vector3f getDirection()

Gets the direction of the projectile.

Returns:

the direction as a normalized Vector3f.

setDirection

public void setDirection(Vector3f direction)

Changes the direction of the projectile.

Parameters:

direction - the new direction.

setDirection

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

Changes the direction of the projectile.

Parameters:

x - the new x direction.

y - the new y direction.

z - the new z direction.

getProjectileDefinition

public Items.ProjectileDefinition getProjectileDefinition()

Gets the definition of the projectile that was fired.

Returns:

the projectile definition.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.

Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onEnterArea(PlayerEnterAreaEvent evt){
5	//Now the player will not be able to enter the area, i.e.
6	//he will be teleported back to his old position (outside the area)
7	evt.setCancelled(true);
8	}
9	}