Package games.stendhal.server.core.config.zone

Class PortalSetupDescriptor

java.lang.Object

games.stendhal.server.core.config.zone.SetupDescriptor

games.stendhal.server.core.config.zone.EntitySetupDescriptor

games.stendhal.server.core.config.zone.PortalSetupDescriptor

public class PortalSetupDescriptor
extends EntitySetupDescriptor

A portal setup descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	associatedZones
protected Object	destinationIdentifier	The named destination portal (if any).
protected String	destinationZone	The destination zone name (if any).
protected Object	identifier	The named portal identifier.
protected boolean	replacing	Whether replacing an existing portal at that location.

Fields inherited from class games.stendhal.server.core.config.zone.EntitySetupDescriptor

attributes, className, x, y

Fields inherited from class games.stendhal.server.core.config.zone.SetupDescriptor

parameters

Constructor Summary

Constructors

Constructor	Description
PortalSetupDescriptor(int x, int y, Object identifier)	Create a portal setup descriptor.

Method Summary

Modifier and Type	Method	Description
Object	getDestinationIdentifier()	Get the destination identifier.
String	getDestinationZone()	Get the destination zone.
Object	getIdentifier()	Get the identifier.
boolean	isReplacing()	Determine if existing portals are replaced.
void	setAssociatedZones(String zones)	For house portals.
void	setDestination(String zone, Object identifier)	Set the destination zone/identifier.
void	setReplacing(boolean replacing)	Set whether to replace any existing portal.
void	setup(StendhalRPZone zone)	Do appropriate zone setup.

Methods inherited from class games.stendhal.server.core.config.zone.EntitySetupDescriptor

addPort, getAttributes, getImplementation, getX, getY, setAttribute, setConnectorName, setImplementation

Methods inherited from class games.stendhal.server.core.config.zone.SetupDescriptor

getParameters, setParameter

Methods inherited from class java.lang.Object

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

Field Details

identifier

protected Object identifier

The named portal identifier.

destinationZone

protected String destinationZone

The destination zone name (if any).

associatedZones

protected String associatedZones

destinationIdentifier

protected Object destinationIdentifier

The named destination portal (if any).

replacing

protected boolean replacing

Whether replacing an existing portal at that location.

Constructor Details

PortalSetupDescriptor

public PortalSetupDescriptor(int x,
 int y,
 Object identifier)

Create a portal setup descriptor.

Parameters:

x - The X coordinate.

y - The Y coordinate.

identifier - The identifier,

Method Details

getDestinationIdentifier

public Object getDestinationIdentifier()

Get the destination identifier.

Returns:

An identifier.

getDestinationZone

public String getDestinationZone()

Get the destination zone.

Returns:

A zone name.

getIdentifier

public Object getIdentifier()

Get the identifier.

Returns:

An identifier.

isReplacing

public boolean isReplacing()

Determine if existing portals are replaced.

Returns:

true if replacing an existing portal at that location.

setDestination

public void setDestination(String zone,
 Object identifier)

Set the destination zone/identifier.

Parameters:

zone - The destination zone name.

identifier - The named destination portal.

setReplacing

public void setReplacing(boolean replacing)

Set whether to replace any existing portal.

Parameters:

replacing - Whether replacing an existing portal at that location.

setAssociatedZones

public void setAssociatedZones(String zones)

For house portals.

setup

public void setup(StendhalRPZone zone)

Do appropriate zone setup.

Overrides:

setup in class EntitySetupDescriptor

Parameters:

zone - The zone.