Package org.sgrewritten.stargate.api.gate

Class ImplicitGateBuilder

java.lang.Object

org.sgrewritten.stargate.api.gate.ImplicitGateBuilder

All Implemented Interfaces:

GateBuilder

public class ImplicitGateBuilder
extends Object
implements GateBuilder

Scans through available gate formats, given a sign position. Finds all parameters for a valid gate format, or throws an exception if no format matched. If one already knows these parameters, look into ExplicitGateBuilder

Constructor Summary

Constructors

Constructor	Description
ImplicitGateBuilder(org.bukkit.Location signLocation, RegistryAPI registryAPI)	Construct an instance of ImplicitGateBuilder

Method Summary

Modifier and Type	Method	Description
GateAPI	build()	Creates a new gate from the given sign
ImplicitGateBuilder	setGenerateButtonPositions(boolean generateButtonPositions)	Whether to generate a button position.

Methods inherited from class java.lang.Object

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

Constructor Details

ImplicitGateBuilder

public ImplicitGateBuilder(org.bukkit.Location signLocation,
 RegistryAPI registryAPI)

Construct an instance of ImplicitGateBuilder

Parameters:

signLocation -

The location of the sign to figure out gate format

registryAPI -

The stargate registry containing portal and network data

Method Details

setGenerateButtonPositions

public ImplicitGateBuilder setGenerateButtonPositions(boolean generateButtonPositions)

Description copied from interface: GateBuilder

Whether to generate a button position. This might not be necessary for gates such as always on gates

Specified by:

setGenerateButtonPositions in interface GateBuilder

Parameters:

generateButtonPositions -

Whether to generate a button position.

Returns:

This gate builder (convenience)

build

public GateAPI build()
              throws NoFormatFoundException,
GateConflictException

Creates a new gate from the given sign

Specified by:

build in interface GateBuilder

Returns:

A new Gate

Throws:

NoFormatFoundException -

If no gate format is found that matches the physical gate

GateConflictException -

If a registered gate conflicts with the new gate