com.sk89q.worldedit.util

Class TargetBlock

java.lang.Object

com.sk89q.worldedit.util.TargetBlock

public class TargetBlock
extends Object

This class uses an inefficient method to figure out what block a player is looking towards. Originally written by toi. It was ported to WorldEdit and trimmed down by sk89q. Thanks to Raphfrk for optimization of toi's original class.

Author:

toi

Constructor Summary

Constructors

Constructor and Description
TargetBlock(LocalPlayer player) Constructor requiring a player, uses default values
TargetBlock(LocalPlayer player, int maxDistance, double checkDistance) Constructor requiring a player, max distance and a checking distance

Method Summary

Methods

Modifier and Type	Method and Description
BlockWorldVector	getAnyTargetBlock() Returns any block at the sight.
WorldVectorFace	getAnyTargetBlockFace()
BlockWorldVector	getCurrentBlock() Returns the current block along the line of vision
BlockWorldVector	getNextBlock() Get next block
BlockWorldVector	getPreviousBlock() Returns the previous block in the aimed path
BlockWorldVector	getSolidTargetBlock() Returns the block at the sight.
BlockWorldVector	getTargetBlock() Returns the block at the sight.
WorldVectorFace	getTargetBlockFace()

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetBlock

public TargetBlock(LocalPlayer player)

Constructor requiring a player, uses default values

Parameters:

player - player to work with

TargetBlock

public TargetBlock(LocalPlayer player,
           int maxDistance,
           double checkDistance)

Constructor requiring a player, max distance and a checking distance

Parameters:

player - LocalPlayer to work with

maxDistance - how far it checks for blocks

checkDistance - how often to check for blocks, the smaller the more precise

Method Detail

getAnyTargetBlock

public BlockWorldVector getAnyTargetBlock()

Returns any block at the sight. Returns null if out of range or if no viable target was found. Will try to return the last valid air block it finds.

Returns:

Block

getTargetBlock

public BlockWorldVector getTargetBlock()

Returns the block at the sight. Returns null if out of range or if no viable target was found

Returns:

Block

getSolidTargetBlock

public BlockWorldVector getSolidTargetBlock()

Returns the block at the sight. Returns null if out of range or if no viable target was found

Returns:

Block

getNextBlock

public BlockWorldVector getNextBlock()

Get next block

Returns:

next block position

getCurrentBlock

public BlockWorldVector getCurrentBlock()

Returns the current block along the line of vision

Returns:

block position

getPreviousBlock

public BlockWorldVector getPreviousBlock()

Returns the previous block in the aimed path

Returns:

block position

getAnyTargetBlockFace

public WorldVectorFace getAnyTargetBlockFace()

getTargetBlockFace

public WorldVectorFace getTargetBlockFace()