GameObject.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 java.util.Iterator;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.baseobject.GameObjectContainer;
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 interface GameObject<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends BaseObject<G, A, R, G> {
 
    String EDITOR_FOLDER_INTERN = "intern";
 
    void removeAll();
 
    void addLast(@NotNull G gameObject);
 
    @Nullable
    G getLast();
 
    void addFirst(@NotNull G gameObject);
 
    @Nullable
    G getFirst();
 
    void propagateElevation(@NotNull BaseObject<?, ?, ?, ?> gameObject);
 
    void updateTileStretch(int heightValue, boolean isAbsolute, @NotNull Integer @Nullable [] subLayers);
 
    void applyMassChange(@NotNull Integer @NotNull [] layers, @NotNull Integer @NotNull [] subLayers, @NotNull String changes);
 
    @NotNull
    @Override
    Iterator<G> iterator();
 
    @NotNull
    Iterable<G> reverse();
 
    @NotNull
    Iterable<G> recursive();
 
    boolean isScripted();
 
    boolean isEmpty();
 
    void remove();
 
    @Nullable
    GameObjectContainer<G, A, R> getContainer();
 
    boolean isTop();
 
    boolean isBottom();
 
    void moveTop();
 
    void moveUp();
 
    void moveDown();
 
    void moveBottom();
 
    void insertBefore(@NotNull G node);
 
    void insertAfter(@NotNull G node);
 
    @Nullable
    G getContainerGameObject();
 
    @NotNull
    G getTopContainer();
 
    void setContainer(@Nullable GameObjectContainer<G, A, R> container, int mapX, int mapY);
 
    boolean isInContainer();
 
    @NotNull
    MapSquare<G, A, R> getMapSquare();
 
    @Nullable
    MapSquare<G, A, R> getMapSquareOptional();
 
    @Nullable
    G getPrev();
 
    @Nullable
    G getNext();
 
    void setArchetype(@NotNull R archetype);
 
    boolean hasUndefinedArchetype();
 
    void markModified();
 
    int getLightRadius();
 
}