Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
Public Member Functions | List of all members
org.bukkit.TravelAgent Interface Reference

Public Member Functions

TravelAgent setSearchRadius (int radius)
 Set the Block radius to search in for available portals.
 
int getSearchRadius ()
 Gets the search radius value for finding an available portal.
 
TravelAgent setCreationRadius (int radius)
 Sets the maximum radius from the given location to create a portal.
 
int getCreationRadius ()
 Gets the maximum radius from the given location to create a portal.
 
boolean getCanCreatePortal ()
 Returns whether the TravelAgent will attempt to create a destination portal or not.
 
void setCanCreatePortal (boolean create)
 Sets whether the TravelAgent should attempt to create a destination portal or not.
 
Location findOrCreate (Location location)
 Attempt to find a portal near the given location, if a portal is not found it will attempt to create one.
 
Location findPortal (Location location)
 Attempt to find a portal near the given location.
 
boolean createPortal (Location location)
 Attempt to create a portal near the given location.
 

Detailed Description

Definition at line 3 of file TravelAgent.java.

Member Function Documentation

boolean org.bukkit.TravelAgent.createPortal ( Location  location)

Attempt to create a portal near the given location.

Parameters
locationThe desired location of the portal.
Returns
True if a nether portal was successfully created.
Location org.bukkit.TravelAgent.findOrCreate ( Location  location)

Attempt to find a portal near the given location, if a portal is not found it will attempt to create one.

Parameters
locationThe location where the search for a portal should begin.
Returns
Returns the location of a portal which has been found or returns the location passed to the method if unsuccessful.
Location org.bukkit.TravelAgent.findPortal ( Location  location)

Attempt to find a portal near the given location.

Parameters
locationThe desired location of the portal.
Returns
Returns the location of the nearest portal to the location.
boolean org.bukkit.TravelAgent.getCanCreatePortal ( )

Returns whether the TravelAgent will attempt to create a destination portal or not.

Returns
Return whether the TravelAgent should create a destination portal or not.
int org.bukkit.TravelAgent.getCreationRadius ( )

Gets the maximum radius from the given location to create a portal.

Returns
Returns the currently set creation radius.
int org.bukkit.TravelAgent.getSearchRadius ( )

Gets the search radius value for finding an available portal.

Returns
Returns the currently set search radius.
void org.bukkit.TravelAgent.setCanCreatePortal ( boolean  create)

Sets whether the TravelAgent should attempt to create a destination portal or not.

Parameters
createSets whether the TravelAgent should create a destination portal or not.
TravelAgent org.bukkit.TravelAgent.setCreationRadius ( int  radius)

Sets the maximum radius from the given location to create a portal.

Parameters
radiusThe radius in which to create a portal from the location.
Returns
This travel agent.
TravelAgent org.bukkit.TravelAgent.setSearchRadius ( int  radius)

Set the Block radius to search in for available portals.

Parameters
radiusThe radius in which to search for a portal from the location.
Returns
This travel agent.
The documentation for this interface was generated from the following file: