Package net.risingworld.api.utils

Class AreaSelectionResult

java.lang.Object

net.risingworld.api.utils.AreaSelectionResult

public final class AreaSelectionResult
extends Object

Represents the currently selected area when using the selection tool. See Player.enableAreaSelectionTool(boolean) and Player.getAreaSelectionData(net.risingworld.api.callbacks.Callback)

Method Summary

Modifier and Type	Method	Description
Vector3f	getEndPosition()	Gets the end position.
Vector3f	getStartPosition()	Gets the start position.
boolean	isEndPositionSet()	Checks if the player has already set an end position for the area.
boolean	isStartPositionSet()	Checks if the player has already set a start position for the area.
String	toString()	Gets a String representation of this AreaSelectionResult.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getStartPosition

public Vector3f getStartPosition()

Gets the start position. If no start position was set, null is returned.

Returns:

the selected start position, or null if no start position was set.

isStartPositionSet

public boolean isStartPositionSet()

Checks if the player has already set a start position for the area.

Returns:

true if a start position was set, false if not.

getEndPosition

public Vector3f getEndPosition()

Gets the end position. If no end position was set, null is returned.

Returns:

the selected end position, or null if no end position was set.

isEndPositionSet

public boolean isEndPositionSet()

Checks if the player has already set an end position for the area.

Returns:

true if an end position was set, false if not.

toString

public String toString()

Gets a String representation of this AreaSelectionResult.

Overrides:

toString in class Object

Returns:

a string representing the values of this AreaSelectionResult.