View Javadoc

1   /**
2    * Copyright 2006 Matthew Purland (m.purland@gmail.com)
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.mud4j.damage;
18  
19  /**
20   * Interface for objects to implement that want the ability to be damaged.  
21   * Once the object has sustained enough damage, it will cease to be.
22   * 
23   * Once an object implements, if the object will sustain damage, it will
24   * 
25   * An object that implements this should use the composite pattern to delegate
26   * any methods to a DamageBehavior object
27   * 
28   * @author Matthew Purland
29   */
30  public interface Damageable {
31      /**
32       * Get the defined damage behavior for the damageable entity.
33       * 
34       * @return Returns the damage behavior for the damageable object.
35       */
36      public DamageBehavior getDamageBehavior();
37      
38      /**
39       * Sets the damage behavior for the damageable object.
40       * 
41       * @param behavior DamageBehavior behavior object to set.
42       */
43      public void setDamageBehavior(DamageBehavior damageBehavior);
44  }