Package games.stendhal.server.entity.mapstuff.area

Class OccupantAreaFactory

java.lang.Object

games.stendhal.server.entity.mapstuff.area.OccupantAreaFactory

All Implemented Interfaces:

ConfigurableFactory

Direct Known Subclasses:

DamagingAreaFactory, LifeDrainAreaFactory

public abstract class OccupantAreaFactory
extends Object
implements ConfigurableFactory

A base factory for OccupantArea objects.

Constructor Summary

Constructors

Constructor	Description
OccupantAreaFactory()

Method Summary

Modifier and Type	Method	Description
Object	create(ConfigurableFactoryContext ctx)	Create an object.
protected abstract OccupantArea	createArea(ConfigurableFactoryContext ctx)	Creates the OccupantArea.
protected int	getHeight(ConfigurableFactoryContext ctx)	Extract the height from context.
protected int	getInterval(ConfigurableFactoryContext ctx)	Extract the interval (in seconds) to perform actions while stationary.
protected boolean	getPlayersOnly(ConfigurableFactoryContext ctx)	Extract the flag to only affect players.
protected int	getWidth(ConfigurableFactoryContext ctx)	Extract the width from context.

Methods inherited from class java.lang.Object

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

Constructor Details

OccupantAreaFactory

public OccupantAreaFactory()

Method Details

createArea

protected abstract OccupantArea createArea(ConfigurableFactoryContext ctx)

Creates the OccupantArea.

Parameters:

ctx - The configuration context.

Returns:

An OccupantArea.

Throws:

IllegalArgumentException - in case of an invalid configuration

getWidth

protected int getWidth(ConfigurableFactoryContext ctx)

Extract the width from context.

Parameters:

ctx - The configuration context.

Returns:

The width, 1 if unspecified.

Throws:

IllegalArgumentException - If the attribute is invalid.

getHeight

protected int getHeight(ConfigurableFactoryContext ctx)

Extract the height from context.

Parameters:

ctx - The configuration context.

Returns:

The height, 1 if unspecified.

Throws:

IllegalArgumentException - If the attribute is invalid.

getInterval

protected int getInterval(ConfigurableFactoryContext ctx)

Extract the interval (in seconds) to perform actions while stationary.

Parameters:

ctx - The configuration context.

Returns:

The stationary interval (in turns).

Throws:

IllegalArgumentException - if the attribute is missing.

getPlayersOnly

protected boolean getPlayersOnly(ConfigurableFactoryContext ctx)

Extract the flag to only affect players.

Parameters:

ctx - The configuration context.

Returns:

The flag to only affect players.

Throws:

IllegalArgumentException - If the attribute is invalid.

create

public Object create(ConfigurableFactoryContext ctx)

Description copied from interface: ConfigurableFactory

Create an object.

Specified by:

create in interface ConfigurableFactory

Parameters:

ctx - Configuration context.

Returns:

A new object, or null if allowed by the factory type.