gameentityevent.java

MegaMek is a networked Java clone of BattleTech, a turn-based sci-fi boardgame for 2+ players. Fight

/*
 * MegaMek - Copyright (C) 2005 Ben Mazur ([e-mail])
 *
 *  This program is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the Free
 *  Software Foundation; either version 2 of the License, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 *  for more details.
 */

package megamek.common.event;

import megamek.common.Entity;

/**
 * Instances of descendant classes are sent as a result of Game changes
 * related to entities such as addind/removing/changing
 *
 * @see GameEntityChangeEvent
 * @see GameEntityNewEvent
 * @see GameListener
 */
public abstract class GameEntityEvent extends GameEvent {

    protected Entity entity;

    /**
     * Constructs new GameEntityEvent
     * @param source
     * @param entity
     * @param type
     */
    public GameEntityEvent(Object source, Entity entity, int type) {
        super(source,type);
        this.entity = entity;
    }

    /**
     * @return the entity.
     */
    public Entity getEntity() {
        return entity;
    }

}