net.risingworld.api.events.player

Class PlayerElementCollisionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerElementCollisionEvent

public class PlayerElementCollisionEvent
extends PlayerEvent

Called when a player "touches" a World3DModel, or more precisely, when the player collides with the collision shape of the element. This means the event only works for elements which have a collision shape.
If the player does no longer collide with the world element, the event is triggered again (isColliding() returns false in this case).

This event only works if World3DModel.setListenForCollisions(boolean) is set to true.

Constructor Summary

Constructors

Constructor and Description
PlayerElementCollisionEvent(Player player, WorldElement worldElement, boolean colliding, float appliedImpulse)

Method Summary

Modifier and Type	Method and Description
WorldElement	getWorldElement() Gets the world element.
boolean	isColliding() Gets whether or not the player is currently "touching" (colliding with) the element.

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

PlayerElementCollisionEvent

public PlayerElementCollisionEvent(Player player,
                                   WorldElement worldElement,
                                   boolean colliding,
                                   float appliedImpulse)

Method Detail

getWorldElement

public WorldElement getWorldElement()

Gets the world element.

Returns:

the world element.

isColliding

public boolean isColliding()

Gets whether or not the player is currently "touching" (colliding with) the element.

Returns:

true if the player collides with the element (start collision), false if the player is no longer colliding with the element (stop collision). False is only returned if the player collided with the element previously.