AbstractGameObject.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.gameobject;
 
import net.sf.gridarta.model.anim.AnimationObjects;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.baseobject.AbstractBaseObject;
import net.sf.gridarta.model.baseobject.BaseObjectVisitor;
import net.sf.gridarta.model.baseobject.GameObjectContainer;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapSquare;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class AbstractGameObject<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractBaseObject<G, A, R, G> implements GameObject<G, A, R> {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private R archetype;
 
    @Nullable
    private GameObjectContainer<G, A, R> container;
 
    protected AbstractGameObject(@NotNull final R archetype, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final AnimationObjects animationObjects) {
        super(faceObjectProviders, animationObjects);
        this.archetype = archetype;
        updateArchetype();
    }
 
    @Override
    @NotNull
    public String getAttributeString(@NotNull final String attributeName, final boolean queryArchetype) {
        final String result = getAttributeValue(attributeName);
        if (result != null) {
            return result;
        }
        return queryArchetype ? archetype.getAttributeString(attributeName) : "";
    }
 
    @Nullable
    @Override
    protected String getEffectiveFaceName(@NotNull final String faceName) {
        final String normalizedFaceName = faceName.isEmpty() ? null : faceName.intern();
        //Strings are interned
        //noinspection StringEquality
        return normalizedFaceName != null && !normalizedFaceName.isEmpty() && normalizedFaceName != archetype.getFaceName() ? normalizedFaceName : null;
    }
 
    @Override
    public void notifyBeginChange() {
        final MapSquare<G, A, R> mapSquare = getMapSquareOptional();
        if (mapSquare != null) {
            mapSquare.getMapModel().beginGameObjectChange(getThis());
        }
    }
 
    @Override
    public void notifyEndChange() {
        final MapSquare<G, A, R> mapSquare = getMapSquareOptional();
        if (mapSquare != null) {
            mapSquare.getMapModel().endGameObjectChange(getThis());
        }
    }
 
    @Override
    public void notifyTransientChange() {
        final MapSquare<G, A, R> mapSquare = getMapSquareOptional();
        if (mapSquare != null) {
            mapSquare.getMapModel().transientGameObjectChange(getThis());
        }
    }
 
    @NotNull
    @Override
    @SuppressWarnings("unchecked")
    public G clone() {
        final AbstractGameObject<G, A, R> clone = (AbstractGameObject<G, A, R>) super.clone();
        clone.container = null;
        return clone.getThis();
    }
 
    @NotNull
    @Override
    public G asGameObject() {
        return getThis();
    }
 
    @NotNull
    @Override
    public G newInstance(@NotNull final GameObjectFactory<G, A, R> gameObjectFactory) {
        return gameObjectFactory.cloneGameObject(getThis());
    }
 
    @Override
    public void visit(@NotNull final BaseObjectVisitor<G, A, R> baseObjectVisitor) {
        baseObjectVisitor.visit(this);
    }
 
    @Override
    public void remove() {
        final G head = getHead();
        for (G tail = head.getMultiNext(); tail != null; tail = tail.getMultiNext()) {
            final GameObjectContainer<G, A, R> tailContainer = tail.getContainer();
            if (tailContainer == null) {
                throw new NotInsideContainerException(getThis());
            }
            tailContainer.remove(tail);
        }
        final GameObjectContainer<G, A, R> headContainer = head.getContainer();
        if (headContainer == null) {
            throw new NotInsideContainerException(getThis());
        }
        headContainer.remove(head);
    }
 
    @Nullable
    @Override
    public GameObjectContainer<G, A, R> getContainer() {
        return container;
    }
 
    @Override
    public boolean isTop() {
        return container == null || container.isTop(getThis());
    }
 
    @Override
    public boolean isBottom() {
        return container == null || container.isBottom(getThis());
    }
 
    @Override
    public void moveTop() {
        if (container != null) {
            container.moveTop(getThis());
        }
    }
 
    @Override
    public void moveUp() {
        if (container != null) {
            container.moveUp(getThis());
        }
    }
 
    @Override
    public void moveDown() {
        if (container != null) {
            container.moveDown(getThis());
        }
    }
 
    @Override
    public void moveBottom() {
        if (container != null) {
            container.moveBottom(getThis());
        }
    }
 
    @Override
    public void insertBefore(@NotNull final G node) {
        if (container == null) {
            throw new NotInsideContainerException(getThis());
        }
        container.insertBefore(node, getThis());
    }
 
    @Override
    public void insertAfter(@NotNull final G node) {
        if (container == null) {
            throw new NotInsideContainerException(getThis());
        }
        container.insertAfter(getThis(), node);
    }
 
    @Nullable
    @Override
    public G getContainerGameObject() {
        return container == null ? null : container.asGameObject();
    }
 
    @NotNull
    @Override
    public G getTopContainer() {
        if (container != null) {
            final G gameObject = container.asGameObject();
            if (gameObject != null) {
                return gameObject.getTopContainer();
            }
        }
 
        return getThis();
    }
 
    @Override
    public void setContainer(@Nullable final GameObjectContainer<G, A, R> container, final int mapX, final int mapY) {
        this.container = container;
        setMapX(mapX);
        setMapY(mapY);
    }
 
    @Override
    public boolean isInContainer() {
        return container != null && container instanceof GameObject;
    }
 
    @NotNull
    @Override
    public MapSquare<G, A, R> getMapSquare() {
        if (container == null) {
            throw new IllegalStateException("not inside a container");
        }
        return container.getMapSquare();
    }
 
    @Nullable
    @Override
    public MapSquare<G, A, R> getMapSquareOptional() {
        return container == null ? null : container.getMapSquareOptional();
    }
 
    @Nullable
    @Override
    public G getPrev() {
        return container == null ? null : container.getPrev(getThis());
    }
 
    @Nullable
    @Override
    public G getNext() {
        return container == null ? null : container.getNext(getThis());
    }
 
    @NotNull
    @Override
    public R getArchetype() {
        return archetype;
    }
 
    @Override
    public void setArchetype(@NotNull final R archetype) {
        if (this.archetype == archetype) {
            return;
        }
 
        beginGameObjectChange();
        try {
            this.archetype = archetype;
            updateArchetype();
        } finally {
            endGameObjectChange();
        }
    }
 
    @Override
    public boolean hasUndefinedArchetype() {
        return archetype.isUndefinedArchetype();
    }
 
    @Override
    public void markModified() {
        beginGameObjectChange();
        endGameObjectChange();
    }
 
}