mechdisplayevent.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.client.event;

import megamek.common.Entity;
import megamek.common.Mounted;

/**
 * Instances of this class are sent as a result of changes 
 * in MechDisplay
 *
 * @see MechDisplayListener
 */
public class MechDisplayEvent extends java.util.EventObject
{
    public static final int WEAPON_SELECTED = 0;
    
    private int entityId = megamek.common.Entity.NONE;
    private int weaponId = megamek.common.Entity.NONE;
    private Entity entity = null;
    private Mounted equip = null;
    private int type;
    
    public MechDisplayEvent(Object source, Entity entity, Mounted weapon) {
        super(source);
        this.entity = entity;
        this.entityId = entity.getId();
        this.type = WEAPON_SELECTED;
        this.equip = weapon;
        this.weaponId = entity.getEquipmentNum(weapon);
    }

    public MechDisplayEvent(Object source, int type) {
        super(source);
        this.type = type;
    }
    
    /**
     * Returns the type of event that this is
     */
    public int getType() {
        return type;
    }
        
    /**
     * @return the entity ID associated with this event, if
     *         applicable; -1 otherwise.
     */
    public int getEntityId() {
        return entityId;
    }

    /**
     * @return the weapon ID associated with this event, if
     *         applicable; -1 otherwise.
     */
    public int getWeaponId() {
        return weaponId;
    }

    /**
     * @return the entity associated with event, or null
     */
    public Entity getEntity() {
        return entity;
    }

    /**
     * @return the equipment associated with the event or null
     */
    public Mounted getEquip() {
        return equip;
    }
}