net.risingworld.api.events.player.world

Class PlayerPlaceBlueprintEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerPlaceBlueprintEvent

All Implemented Interfaces:

Cancellable

public class PlayerPlaceBlueprintEvent
extends PlayerEvent
implements Cancellable

Called when a user wants to place a blueprint, i.e. a blueprint which was already created previously.

Constructor Summary

Constructors

Constructor and Description
PlayerPlaceBlueprintEvent(Player player, BoundingInformation boundingInformation, int terrain, int blocks, int constructions, int objects)

Method Summary

Modifier and Type	Method and Description
int	getBlockCount() Gets the amount of blocks in this blueprint.
BoundingInformation	getBoundingInformation() Gets the bounding information of the blueprint object.
int	getConstructionCount() Gets the amount of construction elements (windows, planks, beams etc) in this blueprint.
float	getMaxExtent() Gets the max radius of the affected area.
int	getObjectCount() Gets the amount of objects (i.e. furniture, doors, lamps etc) in this blueprint.
Vector3f	getPosition() Gets the target world position of the blueprint, or more precisely, the center position of the affected area.
int	getTerrainCount() Gets the amount of "terrain blocks" in this blueprint.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerPlaceBlueprintEvent

public PlayerPlaceBlueprintEvent(Player player,
                                 BoundingInformation boundingInformation,
                                 int terrain,
                                 int blocks,
                                 int constructions,
                                 int objects)

Method Detail

getBoundingInformation

public BoundingInformation getBoundingInformation()

Gets the bounding information of the blueprint object.

Returns:

the bounding information.

Example: Get the min position and max position of the affected area of this blueprint

1	@EventMethod
2	public void onPlayerPlaceBlueprint(PlayerPlaceBlueprintEvent event){
3	BoundingInformation bound = event.getBoundingInformation();
4	//Our vector to store the min world position of this bounding info
5	Vector3f minPosition = new Vector3f();
6
7	//Our vector to store the max world position of this bounding info
8	Vector3f maxPosition = new Vector3f();
9
10	//getCenter() gets the center of this bounding information. By subtracting
11	//the half extents (half sizes), we get the min world position of this
12	//bounding information
13	minPosition.set(bound.getCenter());
14	minPosition.subtractLocal(bound.getXExtent(), bound.getYExtent(), bound.getZExtent());
15
16	//...by adding the half extents, we get the max world position instead
17	maxPosition.set(bound.getCenter());
18	maxPosition.addLocal(bound.getXExtent(), bound.getYExtent(), bound.getZExtent());
19	}

getPosition

public Vector3f getPosition()

Gets the target world position of the blueprint, or more precisely, the center position of the affected area. This is the same as calling getBoundingInformation().getCenter()

Returns:

the target world position.

getMaxExtent

public float getMaxExtent()

Gets the max radius of the affected area. This function simply compares the half extents of the bounding information and returns the greatest result.

Returns:

the max radius of the affected area.

getTerrainCount

public int getTerrainCount()

Gets the amount of "terrain blocks" in this blueprint.

Returns:

the amount of terrain / terrain blocks.

getBlockCount

public int getBlockCount()

Gets the amount of blocks in this blueprint.

Returns:

the amount of blocks.

getConstructionCount

public int getConstructionCount()

Gets the amount of construction elements (windows, planks, beams etc) in this blueprint.

Returns:

the amount of construction elements.

getObjectCount

public int getObjectCount()

Gets the amount of objects (i.e. furniture, doors, lamps etc) in this blueprint.

Returns:

the amount of objects.

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.

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

Specified by:

setCancelled in interface Cancellable

Parameters:

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