BlockRay.BlockRayBuilder (SpongeAPI 7.4.0 API)

java.lang.Object
- org.spongepowered.api.util.blockray.BlockRay.BlockRayBuilder<E>

Type Parameters:

E - The type of the extent for the block ray

All Implemented Interfaces:

Iterable<BlockRayHit<E>>

Enclosing class:

BlockRay<E extends Extent>
```
public static class BlockRay.BlockRayBuilder<E extends Extent>
extends Object
implements Iterable<BlockRayHit<E>>
```
A builder for block ray, which also implements Iterable, making it useful for 'advanced for loops'. Use BlockRay.from(Location) to get an instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BlockRay<E>`	`build()` Returns a block ray build from the settings.
`BlockRay.BlockRayBuilder<E>`	`direction(com.flowpowered.math.vector.Vector3d direction)` Sets the direction.
`BlockRay.BlockRayBuilder<E>`	`distanceLimit(double distanceLimit)` Sets the maximum distance before stopping.
`Optional<BlockRayHit<E>>`	`end()` Iterates the built block ray until the end and returns the last hit, if any.
`Iterator<BlockRayHit<E>>`	`iterator()`
`BlockRay.BlockRayBuilder<E>`	`narrowPhase(boolean enable)` Sets whether or not to perform narrow phase intersections.
`com.flowpowered.math.vector.Vector3d`	`position()` Gets the starting position of the block ray.
`BlockRay.BlockRayBuilder<E>`	`select(Predicate<BlockRayHit<E>> filter)` Adds a filter to the `BlockRay` that determines whether a potential `BlockRayHit` is a valid result, and should therefore be returned by the `BlockRay`, pausing the ray trace.
`BlockRay.BlockRayBuilder<E>`	`skipFilter(Predicate<BlockRayHit<E>>... skipFilters)` Deprecated. Use `select(Predicate)`
`BlockRay.BlockRayBuilder<E>`	`skipFilter(Predicate<BlockRayHit<E>> skipFilter)` Deprecated. Use `select(Predicate)`
`BlockRay.BlockRayBuilder<E>`	`stopFilter(Predicate<BlockRayHit<E>>... stopFilters)` Deprecated.
`BlockRay.BlockRayBuilder<E>`	`stopFilter(Predicate<BlockRayHit<E>> stopFilter)` Deprecated. Confusing name. Use `whilst(Predicate)` instead.
`BlockRay.BlockRayBuilder<E>`	`to(com.flowpowered.math.vector.Vector3d end)` Sets the direction and ending location.
`BlockRay.BlockRayBuilder<E>`	`whilst(Predicate<BlockRayHit<E>> filter)` Adds a filter to the `BlockRay` that determines the conditions upon which a `BlockRay` may continue to iterate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - skipFilter
```
@Deprecated
public BlockRay.BlockRayBuilder<E> skipFilter(Predicate<BlockRayHit<E>> skipFilter)
```
    Deprecated. Use select(Predicate)
    
    Adds the filter to the block ray. The block ray will skip over blocks that do not pass this predicate. This is optional. Multiple filters will be ANDed together.
    
    Parameters:
    
    skipFilter - The filter to add
    
    Returns:
    
    This for chained calls
  - skipFilter
```
@SafeVarargs
 @Deprecated
public final BlockRay.BlockRayBuilder<E> skipFilter(Predicate<BlockRayHit<E>>... skipFilters)
```
    Deprecated. Use select(Predicate)
    
    Adds filters to the block ray. The block ray will skip over blocks that do not pass this predicate. This is optional. Multiple filters will be ANDed together.
    
    Parameters:
    
    skipFilters - The filters to add
    
    Returns:
    
    This for chained calls
  - select
```
public final BlockRay.BlockRayBuilder<E> select(Predicate<BlockRayHit<E>> filter)
```
    Adds a filter to the BlockRay that determines whether a potential BlockRayHit is a valid result, and should therefore be returned by the BlockRay, pausing the ray trace. A ray trace that has been paused due to a BlockRayHit being returned by virtue of this predicate may be continued by calling BlockRay.next() on the associated BlockRay.
    Take care when using this in combination with whilst(Predicate). For any predicate supplied here to match a BlockRayHit, it must also be allowed by any predicates supplied to whilst(Predicate).
    
    Only one filter may be applied using this method. If a second filter is applied, it will overwrite the first.
    
    This is optional. If not specified, defaults to BlockRay.allFilter().
    
    Parameters:
    
    filter - A filter which determines whether a ray has completed
    
    Returns:
    
    This builder, for chaining.
    
    See Also:
    
    whilst(Predicate)
  - whilst
```
public final BlockRay.BlockRayBuilder<E> whilst(Predicate<BlockRayHit<E>> filter)
```
    Adds a filter to the BlockRay that determines the conditions upon which a BlockRay may continue to iterate. Such a filter does not cause a BlockRayHit to be returned, instead, it defines the point in which a BlockRay trace should be considered to be at its end and should not attempt to trace further.
    The block ray will continue while the BlockRayHits that are supplied to this Predicate return true. It will end when a BlockRayHit fails the supplied predicate - at which point the iteration will end and no further calls to BlockRay.next() will be possible.
    
    For example, if you supply the following filter to this method:
```
     input -> {
         BlockType type = input.getLocation().getBlockType();
         return type == BlockTypes.AIR || type == BlockTypes.WATER;
     }
 
```
    then the BlockRay will trace through air and water, stopping when at the boundary of any other block not matched by the predicate.
    
    Only one filter may be applied using this method. If a second filter is applied, it will overwrite the first.
    
    This is optional. If not specified, defaults to BlockRay.allFilter()
    
    If you wish to cause the ray to return a BlockRayHit, supply a predicate to select(Predicate) instead.
    Parameters:
    
    filter - The filter to add
    
    Returns:
    
    This builder, for chaining.
    
    See Also:
    
    select(Predicate)
  - stopFilter
```
@Deprecated
public BlockRay.BlockRayBuilder<E> stopFilter(Predicate<BlockRayHit<E>> stopFilter)
```
    Deprecated. Confusing name. Use whilst(Predicate) instead.
    
    Adds the filter to the block ray. The block ray will end if a block does not pass this predicate. This is optional. Multiple filters will be ANDed together.
    
    Parameters:
    
    stopFilter - The filter to add
    
    Returns:
    
    This for chained calls
  - stopFilter
```
@SafeVarargs
 @Deprecated
public final BlockRay.BlockRayBuilder<E> stopFilter(Predicate<BlockRayHit<E>>... stopFilters)
```
    Deprecated.
    
    Adds filters to the block ray. The block ray will end if a block does not pass this predicate. This is optional. Multiple filters will be ANDed together.
    
    Parameters:
    
    stopFilters - The filters to add
    
    Returns:
    
    This for chained calls
  - to
```
public BlockRay.BlockRayBuilder<E> to(com.flowpowered.math.vector.Vector3d end)
```
    Sets the direction and ending location. This or setting the direction is required and can only be done once.
    
    Parameters:
    
    end - The ending location
    
    Returns:
    
    This for chained calls
  - direction
```
public BlockRay.BlockRayBuilder<E> direction(com.flowpowered.math.vector.Vector3d direction)
```
    Sets the direction. This or setting the ending location is required and can only be done once.
    
    Parameters:
    
    direction - The direction
    
    Returns:
    
    This for chained calls
  - distanceLimit
```
public BlockRay.BlockRayBuilder<E> distanceLimit(double distanceLimit)
```
    Sets the maximum distance before stopping. This is a safeguard to prevent infinite iteration. Default value is 1000. Use a negative value to disable this.
    
    Parameters:
    
    distanceLimit - The distance limit
    
    Returns:
    
    This for chained calls
  - narrowPhase
```
public BlockRay.BlockRayBuilder<E> narrowPhase(boolean enable)
```
    Sets whether or not to perform narrow phase intersections. The narrow phase performs intersections with the block selection boxes if they are smaller than a voxel. This is necessary to obtain correct intersections with small blocks like: signs, buttons, fences, etc. This is enabled by default.
    
    Parameters:
    
    enable - Whether or not to enable the narrow phase
    
    Returns:
    
    This for chained calls
  - position
```
public com.flowpowered.math.vector.Vector3d position()
```
    Gets the starting position of the block ray. Given here since some filters might require it.
    
    Returns:
    
    The position of the block ray
  - build
```
public BlockRay<E> build()
```
    Returns a block ray build from the settings. An ending location or direction needs to have been set.
    
    Returns:
    
    A block ray
  - iterator
```
public Iterator<BlockRayHit<E>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<BlockRayHit<E extends Extent>>
  - end
```
public Optional<BlockRayHit<E>> end()
```
    Iterates the built block ray until the end and returns the last hit, if any.
    
    Returns:
    
    The last block hit, if any
    
    See Also:
    
    build(), BlockRay.end()

Class BlockRay.BlockRayBuilder<E extends Extent>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

skipFilter

skipFilter

select

whilst

stopFilter

stopFilter

to

direction

distanceLimit

narrowPhase

position

build

iterator

end