BaseObject.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.model.baseobject;
 
import java.awt.Point;
import java.io.Serializable;
import javax.swing.ImageIcon;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.FaceSource;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.gameobject.GameObjectFactory;
import net.sf.gridarta.model.gameobject.MultiArchData;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public interface BaseObject<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>, T extends BaseObject<G, A, R, T>> extends Attributes, Cloneable, Iterable<G>, Serializable {
 
    int EDIT_TYPE_NONE = 0x10000; // special case
 
    @NotNull
    String ANIMATION = "animation";
 
    @NotNull
    String DIRECTION = "direction";
 
    @NotNull
    String FACE = "face";
 
    @NotNull
    String NAME = "name";
 
    @NotNull
    String TYPE = "type";
 
    @NotNull
    String TITLE = "title";
 
    @NotNull
    String IS_ANIMATED = "is_animated";
 
    @NotNull
    String IS_TURNABLE = "is_turnable";
 
    @NotNull
    String HP = "hp";
 
    @NotNull
    String SP = "sp";
 
    @NotNull
    String NO_PASS = "no_pass";
 
    @NotNull
    String NO_PICK = "no_pick";
 
    @NotNull
    String LEVEL = "level";
 
    @NotNull
    String SLAYING = "slaying";
 
    @NotNull
    String LAST_HEAL = "last_heal";
 
    @NotNull
    String BLOCKSVIEW = "blocksview";
 
    @NotNull
    String ANIM_SPEED = "anim_speed";
 
    int getTypeNo();
 
    @Nullable
    String getFaceName();
 
    int countInvObjects();
 
    boolean hasAttribute(@NotNull String attributeName, boolean queryArchetype);
 
    @NotNull
    String getAttributeString(@NotNull String attributeName, boolean queryArchetype);
 
    int getAttributeInt(@NotNull String attributeName, boolean queryArchetype);
 
    long getAttributeLong(@NotNull String attributeName, boolean queryArchetype);
 
    double getAttributeDouble(@NotNull String attributeName, boolean queryArchetype);
 
    void setAttributeString(@NotNull String attributeName, @NotNull String value);
 
    void notifyBeginChange();
 
    void notifyEndChange();
 
    void notifyTransientChange();
 
    @NotNull
    R getArchetype();
 
    int getEditType();
 
    void setEditType(int editType);
 
    void addMsgTextLine(@NotNull String text);
 
    @Nullable
    String getMsgText(boolean queryArchetype);
 
    void setMsgText(@Nullable String msgText);
 
    int getMapX();
 
    int getMapY();
 
    @NotNull
    Point getMapLocation();
 
    void setMapX(int mapX);
 
    void setMapY(int mapY);
 
    boolean isHead();
 
    @Nullable
    T getMultiNext();
 
    int getMultiRefCount();
 
    void addTailPart(@NotNull T tail);
 
    void removeTailParts();
 
    T getHead();
 
    boolean isTail();
 
    int getSizeX();
 
    int getSizeY();
 
    int getMaxX();
 
    int getMaxY();
 
    int getMinX();
 
    int getMinY();
 
    @NotNull
    String getObjName();
 
    @NotNull
    String getBestName();
 
    @NotNull
    String getObjectText();
 
    void addObjectText(@NotNull String line);
 
    void setObjectText(@NotNull String objectText);
 
    boolean isDefaultGameObject();
 
    boolean isEqual(@NotNull BaseObject<?, ?, ?, ?> gameObject);
 
    int getDirection();
 
    @NotNull
    FaceSource getFaceObjSource();
 
    @Nullable
    String getAnimName();
 
    boolean isMulti();
 
    void setMulti(@NotNull MultiArchData<G, A, R, T> multi);
 
    @Nullable
    String getFaceObjName();
 
    void setObjectFace();
 
    @NotNull
    ImageIcon getNormalImage();
 
    @NotNull
    T clone();
 
    @NotNull
    String getLoreText();
 
    void setLoreText(@NotNull CharSequence loreText);
 
    @NotNull
    G newInstance(@NotNull GameObjectFactory<G, A, R> gameObjectFactory);
 
    void visit(@NotNull BaseObjectVisitor<G, A, R> baseObjectVisitor);
 
    boolean usesDirection();
 
    void facesReloaded();
 
    @NotNull
    String toString(@NotNull String format);
 
}