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

Class DamagingAreaFactory

java.lang.Object

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

games.stendhal.server.entity.mapstuff.area.DamagingAreaFactory

All Implemented Interfaces:

ConfigurableFactory

public class DamagingAreaFactory
extends OccupantAreaFactory

A base factory for DamagingArea objects.

Constructor Summary

Constructors

Constructor	Description
DamagingAreaFactory()

Method Summary

Modifier and Type	Method	Description
protected OccupantArea	createArea(ConfigurableFactoryContext ctx)	Creates the OccupantArea.
protected int	getDamage(ConfigurableFactoryContext ctx)	Extract the damage amount from a context.
protected double	getProbability(ConfigurableFactoryContext ctx)	Extract the moving damage probability (as percent) from a context.

Methods inherited from class games.stendhal.server.entity.mapstuff.area.OccupantAreaFactory

create, getHeight, getInterval, getPlayersOnly, getWidth

Methods inherited from class java.lang.Object

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

Constructor Details

DamagingAreaFactory

public DamagingAreaFactory()

Method Details

getDamage

protected int getDamage(ConfigurableFactoryContext ctx)

Extract the damage amount from a context.

Parameters:

ctx - The configuration context.

Returns:

The damage amount.

Throws:

IllegalArgumentException - If the attribute is missing.

getProbability

protected double getProbability(ConfigurableFactoryContext ctx)

Extract the moving damage probability (as percent) from a context.

Parameters:

ctx - The configuration context.

Returns:

The damage probability (0.0 - 1.0).

Throws:

IllegalArgumentException - If the attribute is invalid.

createArea

protected OccupantArea createArea(ConfigurableFactoryContext ctx)

Creates the OccupantArea.

Specified by:

createArea in class OccupantAreaFactory

Parameters:

ctx - The configuration context.

Returns:

An OccupantArea.

Throws:

IllegalArgumentException - in case of an invalid configuration