net.risingworld.api.events.player.world

Class PlayerPlaceConstructionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerConstructionEvent

net.risingworld.api.events.player.world.PlayerPlaceConstructionEvent

All Implemented Interfaces:

Cancellable

public class PlayerPlaceConstructionEvent
extends PlayerConstructionEvent
implements Cancellable

Called when the player places a construction element.

Constructor Summary

Constructors

Constructor and Description
PlayerPlaceConstructionEvent(Player player, commons.constructions.ConstructionElement construct)
PlayerPlaceConstructionEvent(Player player, short typeid, int texture, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, short sx, short sy, short sz, byte repetitionsh, byte repetitionsv, byte gap)

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setConstructionPosition(float x, float y, float z) Changes the position of the construction element.
void	setConstructionPosition(Vector3f position) Changes the position of the construction element.
void	setConstructionRotation(float pitch, float yaw, float roll) Changes the rotation of the construction element.
void	setConstructionRotation(Quaternion rotation) Changes the rotation of the construction element.
void	setConstructionSize(float x, float y, float z) Changes the size of the construction element.
void	setConstructionSize(Vector3f size) Changes the size of the construction element.
void	setConstructionTextureID(int texture) Sets the texture of the construction element.
void	setConstructionTypeID(short id) Sets the type ID of the construction element.

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

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getConstructionDefinition, getConstructionPosition, getConstructionPositionX, getConstructionPositionY, getConstructionPositionZ, getConstructionRotation, getConstructionRotationX, getConstructionRotationY, getConstructionRotationZ, getConstructionSize, getConstructionSizeX, getConstructionSizeY, getConstructionSizeZ, getConstructionTextureID, getConstructionTypeID, getPX, getPY, getPZ, getRX, getRY, getRZ, getSX, getSY, getSZ

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

PlayerPlaceConstructionEvent

public PlayerPlaceConstructionEvent(Player player,
                                    commons.constructions.ConstructionElement construct)

PlayerPlaceConstructionEvent

public PlayerPlaceConstructionEvent(Player player,
                                    short typeid,
                                    int texture,
                                    int cx,
                                    int cy,
                                    int cz,
                                    short px,
                                    short py,
                                    short pz,
                                    short rx,
                                    short ry,
                                    short rz,
                                    short sx,
                                    short sy,
                                    short sz,
                                    byte repetitionsh,
                                    byte repetitionsv,
                                    byte gap)

Method Detail

setConstructionTypeID

public void setConstructionTypeID(short id)

Sets the type ID of the construction element.

Parameters:

id - the new type ID.

setConstructionTextureID

public void setConstructionTextureID(int texture)

Sets the texture of the construction element.

Parameters:

texture - the new texture ID. If this is a "poster" construction element, the texture ID is the custom image ID.

setConstructionPosition

public void setConstructionPosition(Vector3f position)

Changes the position of the construction element.

Parameters:

position - the new world position of the construction element.

setConstructionPosition

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

Changes the position of the construction element.

Parameters:

x - the new world x position of the construction element.

y - the new world y position of the construction element.

z - the new world z position of the construction element.

setConstructionRotation

public void setConstructionRotation(Quaternion rotation)

Changes the rotation of the construction element.

Parameters:

rotation - the new construction element rotation. Set to null to reset the rotation (Quaternion.IDENTITY).

setConstructionRotation

public void setConstructionRotation(float pitch,
                                    float yaw,
                                    float roll)

Changes the rotation of the construction element.

Parameters:

pitch - the new x angle, as euler rotation (pitch).

yaw - the new y angle, as euler rotation (yaw).

roll - the new z angle, as euler rotation (roll).

Example: Rotate the construction element by 90 degree around the Y (vertical) axis

1	@EventMethod
2	public void onConstructionPlace(PlayerPlaceConstructionEvent event){
3	//Get the current rotation of the construction element (pitch, yaw, roll)
4	float pitch = event.getConstructionRotationX();
5	float yaw = event.getConstructionRotationY();
6	float roll = event.getConstructionRotationZ();
7
8	//Now we want to rotate the element by 90 degree around the Y axis:
9	//So we add PI/2 (half PI == 90 degree) to the yaw value
10	yaw += Utils.MathUtils.HALF_PI;
11
12	//Set the new rotation. We didn't touch pitch and roll.
13	event.setConstructionRotation(pitch, yaw, roll);
14	}

setConstructionSize

public void setConstructionSize(Vector3f size)

Changes the size of the construction element.

Parameters:

size - the new size (x, y, z, as a Vector3f) of the construction element.

setConstructionSize

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

Changes the size of the construction element.

Parameters:

x - the new size of the construction element along the x axis.

y - the new size of the construction element along the y axis.

z - the new size of the construction element along the z axis.

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.