AbstractGameObject (Gridarta)

java.lang.Object
- net.sf.gridarta.model.baseobject.GameObjectContainer<G,A,R>
- - net.sf.gridarta.model.baseobject.AbstractBaseObject<G,A,R,G>
  - - net.sf.gridarta.model.gameobject.AbstractGameObject<G,A,R>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<G>, Attributes, BaseObject<G,A,R,G>, GameObject<G,A,R>

Direct Known Subclasses:

DefaultIsoGameObject, GameObject
```
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>
```
Abstract base class of GameObject implementations.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface net.sf.gridarta.model.gameobject.GameObject
  EDITOR_FOLDER_INTERN
- Fields inherited from interface net.sf.gridarta.model.baseobject.BaseObject
  ANIM_SPEED, ANIMATION, BLOCKSVIEW, DIRECTION, EDIT_TYPE_NONE, FACE, HP, IS_ANIMATED, IS_TURNABLE, LAST_HEAL, LEVEL, NAME, NO_PASS, NO_PICK, SLAYING, SP, TITLE, TYPE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractGameObject(R archetype, FaceObjectProviders faceObjectProviders, AnimationObjects animationObjects)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`G`	`asGameObject()` Returns this instance as a `GameObject` or `null` if this instance is not a game object.
`G`	`clone()`
`R`	`getArchetype()` Returns the Archetype this GameObject is based on.
`java.lang.String`	`getAttributeString(java.lang.String attributeName, boolean queryArchetype)` Returns the requested attribute value of this GameObject as `String`.
`GameObjectContainer<G,A,R>`	`getContainer()` Returns container of this GameObject.
`G`	`getContainerGameObject()` Returns the environment game object if this game object is in the inventory or `null`.
`protected java.lang.String`	`getEffectiveFaceName(java.lang.String faceName)` Returns the effective face name for `AbstractBaseObject.faceName` for a given real face name.
`MapSquare<G,A,R>`	`getMapSquare()` Returns the `MapSquare` of this container.
`G`	`getNext()` Returns the game object succeeding this game object.
`G`	`getPrev()` Returns the game object preceding this game object.
`G`	`getTopContainer()` Get the topmost container of this GameObject (in Game sense, which means being in a MapSquare isn't, but being in an GameObject is).
`boolean`	`hasUndefinedArchetype()` Return whether this instance references an undefined archetype.
`void`	`insertAfter(G node)` Insert a GameObject after this GameObject.
`void`	`insertBefore(G node)` Insert a GameObject before this GameObject.
`boolean`	`isBottom()` Returns whether this game object is the bottom-most one.
`boolean`	`isInContainer()` Check whether this GameObject is in a Container (in Gridarta sense, which means being in a MapSquare isn't, but being in an GameObject is).
`boolean`	`isTop()` Returns whether this game object is the top-most one.
`void`	`markModified()` Marks this game object as "modified".
`void`	`moveBottom()` Move this GameObject bottom.
`void`	`moveDown()` Move this GameObject down.
`void`	`moveTop()` Move this GameObject top.
`void`	`moveUp()` Move this GameObject up.
`G`	`newInstance(GameObjectFactory<G,A,R> gameObjectFactory)` Creates a new `GameObject` instance: an `Archetype` is instantiated, a `GameObject` is cloned.
`void`	`notifyBeginChange()` Notify the map model that this container is about to change.
`void`	`notifyEndChange()` Notify the map model that this container has changed.
`void`	`notifyTransientChange()` Notifies the map model that this container has changed but need not be restored by undo/redo.
`void`	`remove()` Remove this GameObject from its container.
`void`	`setArchetype(R archetype)` Set the Archetype of this GameObject.
`void`	`setContainer(GameObjectContainer<G,A,R> container, int mapX, int mapY)` Sets container of this GameObject.
`void`	`visit(BaseObjectVisitor<G,A,R> baseObjectVisitor)` Calls the appropriate `visit()` function of a `BaseObjectVisitor`.

Methods inherited from class net.sf.gridarta.model.baseobject.AbstractBaseObject
addMsgTextLine, addObjectText, addTailPart, beginGameObjectChange, countInvObjects, endGameObjectChange, facesReloaded, getAnimName, getAttributeDouble, getAttributeDouble, getAttributeInt, getAttributeInt, getAttributeKeys, getAttributeLong, getAttributeLong, getAttributeString, getAttributeValue, getBestName, getDirection, getEditType, getFaceName, getFaceObjName, getFaceObjSource, getHead, getLoreText, getMapLocation, getMapX, getMapY, getMaxX, getMaxY, getMinX, getMinY, getMsgText, getMulti, getMultiNext, getMultiRefCount, getNormalImage, getObjectText, getObjName, getSizeX, getSizeY, getThis, getTypeNo, hasAttribute, hasAttribute, isDefaultGameObject, isEqual, isHead, isMulti, isTail, removeAttribute, removeTailParts, setAttributeInt, setAttributeString, setEditType, setLoreText, setMapX, setMapY, setMsgText, setMulti, setObjectFace, setObjectText, setThisContainer, toString, transientGameObjectChange, updateArchetype

Methods inherited from class net.sf.gridarta.model.baseobject.GameObjectContainer
addFirst, addLast, getFirst, getLast, getNext, getPrev, hasSameContents, insertAfter, insertBefore, isBottom, isEmpty, isTop, iterator, moveBottom, moveDown, moveTop, moveUp, recursive, remove, removeAll, replace, reverse, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.gridarta.model.gameobject.GameObject
addFirst, addLast, applyMassChange, getFirst, getLast, getLightRadius, isEmpty, isScripted, iterator, propagateElevation, recursive, removeAll, reverse, updateTileStretch

Methods inherited from interface net.sf.gridarta.model.baseobject.BaseObject
addMsgTextLine, addObjectText, addTailPart, countInvObjects, facesReloaded, getAnimName, getAttributeDouble, getAttributeInt, getAttributeLong, getBestName, getDirection, getEditType, getFaceName, getFaceObjName, getFaceObjSource, getHead, getLoreText, getMapLocation, getMapX, getMapY, getMaxX, getMaxY, getMinX, getMinY, getMsgText, getMultiNext, getMultiRefCount, getNormalImage, getObjectText, getObjName, getSizeX, getSizeY, getTypeNo, hasAttribute, isDefaultGameObject, isEqual, isHead, isMulti, isTail, removeTailParts, setAttributeString, setEditType, setLoreText, setMapX, setMapY, setMsgText, setMulti, setObjectFace, setObjectText, toString, usesDirection

Methods inherited from interface net.sf.gridarta.model.baseobject.Attributes
getAttributeDouble, getAttributeInt, getAttributeLong, getAttributeString, hasAttribute, removeAttribute, setAttributeInt

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - AbstractGameObject
```
protected AbstractGameObject(@NotNull
                             R archetype,
                             @NotNull
                             FaceObjectProviders faceObjectProviders,
                             @NotNull
                             AnimationObjects animationObjects)
```
    Creates a new instance.
    
    Parameters:
    
    archetype - the archetype associated with with game object
    
    faceObjectProviders - the face object providers for looking up faces
    
    animationObjects - the animation objects for looking up animations
- Method Detail
  - getAttributeString
```
@NotNull
public java.lang.String getAttributeString(@NotNull
                                                    java.lang.String attributeName,
                                                    boolean queryArchetype)
```
    Returns the requested attribute value of this GameObject as String. The attribute value is first searched in this GameObject. If queryArchetype == true, additional search is done: if the attribute value is not found and this GameObject is not an Archetype itself, the attribute value is searched in this GameObject's Archetype as well.
    
    Specified by:
    
    getAttributeString in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Parameters:
    
    attributeName - the name of the attribute to search; this will be "attributeName value" in the object text
    
    queryArchetype - whether to query the Archetype of this GameObject: true if the Archetype should be queried as well, false to ignore it
    
    Returns:
    
    the attribute value or an empty String ("") if no such attribute
    
    See Also:
    
    Attributes.getAttributeString(String)
  - getEffectiveFaceName
```
@Nullable
protected java.lang.String getEffectiveFaceName(@NotNull
                                                          java.lang.String faceName)
```
    Returns the effective face name for AbstractBaseObject.faceName for a given real face name.
    
    Specified by:
    
    getEffectiveFaceName in class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Parameters:
    
    faceName - the real face name
    
    Returns:
    
    the effective face name or null if the real face name is unset or equals the archetype's face name
  - notifyBeginChange
```
public void notifyBeginChange()
```
    Notify the map model that this container is about to change.
    
    Specified by:
    
    notifyBeginChange in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Specified by:
    
    notifyBeginChange in class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
  - notifyEndChange
```
public void notifyEndChange()
```
    Notify the map model that this container has changed.
    
    Specified by:
    
    notifyEndChange in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Specified by:
    
    notifyEndChange in class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
  - notifyTransientChange
```
public void notifyTransientChange()
```
    Notifies the map model that this container has changed but need not be restored by undo/redo.
    
    Specified by:
    
    notifyTransientChange in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
  - clone
```
@NotNull
public G clone()
```
    Specified by:
    
    clone in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Overrides:
    
    clone in class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
  - asGameObject
```
@NotNull
public G asGameObject()
```
    Returns this instance as a GameObject or null if this instance is not a game object.
    
    Specified by:
    
    asGameObject in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    this instance or null
  - newInstance
```
@NotNull
public G newInstance(@NotNull
                              GameObjectFactory<G,A,R> gameObjectFactory)
```
    Creates a new GameObject instance: an Archetype is instantiated, a GameObject is cloned.
    
    Specified by:
    
    newInstance in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Parameters:
    
    gameObjectFactory - the game object factory for creating new game objects
    
    Returns:
    
    the new game object instance
  - visit
```
public void visit(@NotNull
                  BaseObjectVisitor<G,A,R> baseObjectVisitor)
```
    Calls the appropriate visit() function of a BaseObjectVisitor.
    
    Specified by:
    
    visit in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Parameters:
    
    baseObjectVisitor - the base object visitor
  - remove
```
public void remove()
```
    Remove this GameObject from its container. Does nothing if the object has no container. This method also takes perfectly well care of multi-part GameObjects.
    
    Specified by:
    
    remove in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
  - getContainer
```
@Nullable
public GameObjectContainer<G,A,R> getContainer()
```
    Returns container of this GameObject. There are two possibilities for the container:
    - Another GameObject, which means this object is in the inventory of that GameObject.
    - A MapSquare, which means that this GameObject is top level on that MapSquare (Crossfire returns null for this).
    Specified by:
    
    getContainer in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the container of this game object
    
    See Also:
    
    GameObject.getTopContainer()
  - isTop
```
public boolean isTop()
```
    Returns whether this game object is the top-most one. Returns true if it has no container.
    
    Specified by:
    
    isTop in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    whether this game object is the top-most one
  - isBottom
```
public boolean isBottom()
```
    Returns whether this game object is the bottom-most one. Returns true if it has no container.
    
    Specified by:
    
    isBottom in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    whether this game object is the bottom-most one
  - moveTop
```
public void moveTop()
```
    Move this GameObject top. Does nothing if the object has no container.
    
    Specified by:
    
    moveTop in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
  - moveUp
```
public void moveUp()
```
    Move this GameObject up. Does nothing if the object has no container.
    
    Specified by:
    
    moveUp in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
  - moveDown
```
public void moveDown()
```
    Move this GameObject down. Does nothing if the object has no container.
    
    Specified by:
    
    moveDown in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
  - moveBottom
```
public void moveBottom()
```
    Move this GameObject bottom. Does nothing if the object has no container.
    
    Specified by:
    
    moveBottom in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
  - insertBefore
```
public void insertBefore(@NotNull
                         G node)
```
    Insert a GameObject before this GameObject.
    
    Specified by:
    
    insertBefore in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    node - GameObject to append
  - insertAfter
```
public void insertAfter(@NotNull
                        G node)
```
    Insert a GameObject after this GameObject.
    
    Specified by:
    
    insertAfter in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    node - GameObject to append
  - getContainerGameObject
```
@Nullable
public G getContainerGameObject()
```
    Returns the environment game object if this game object is in the inventory or null.
    
    Specified by:
    
    getContainerGameObject in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the game object this game object is part of or null
  - getTopContainer
```
@NotNull
public G getTopContainer()
```
    Get the topmost container of this GameObject (in Game sense, which means being in a MapSquare isn't, but being in an GameObject is).
    
    Specified by:
    
    getTopContainer in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the topmost container but always GameObject, never a map square; if this object is topmost itself, it returns itself
    
    See Also:
    
    GameObject.getContainer()
  - setContainer
```
public void setContainer(@Nullable
                         GameObjectContainer<G,A,R> container,
                         int mapX,
                         int mapY)
```
    Sets container of this GameObject. There are two possibilities for the container:
    - Another GameObject, which means this object is in the inventory of that GameObject.
    - A MapSquare, which means that this GameObject is top level on that MapSquare.
    Specified by:
    
    setContainer in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    container - the container of this game object
    
    mapX - the x coordinate on the map or 0
    
    mapY - the y coordinate on the map or 0
  - isInContainer
```
public boolean isInContainer()
```
    Check whether this GameObject is in a Container (in Gridarta sense, which means being in a MapSquare isn't, but being in an GameObject is).
    
    Specified by:
    
    isInContainer in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    true if this GameObject has a Container and the Container is an GameObject, otherwise (no Container or Container is not an GameObject) false
  - getMapSquare
```
@Nullable
public MapSquare<G,A,R> getMapSquare()
```
    Returns the MapSquare of this container.
    
    Specified by:
    
    getMapSquare in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Specified by:
    
    getMapSquare in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the map square of this container or null if this GameObjectContainer is not (yet?) connected to a map (a MapSquare would return itself)
  - getPrev
```
@Nullable
public G getPrev()
```
    Returns the game object preceding this game object.
    
    Specified by:
    
    getPrev in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the successor game object or null if no preceding game object exists.
  - getNext
```
@Nullable
public G getNext()
```
    Returns the game object succeeding this game object.
    
    Specified by:
    
    getNext in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the preceding game object or null if no successor game object exists.
  - getArchetype
```
@NotNull
public R getArchetype()
```
    Returns the Archetype this GameObject is based on.
    
    Specified by:
    
    getArchetype in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,G extends GameObject<G,A,R>>
    
    Returns:
    
    the archetype this game object is based on
  - setArchetype
```
public void setArchetype(@NotNull
                         R archetype)
```
    Set the Archetype of this GameObject.
    
    Specified by:
    
    setArchetype in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    archetype - new Archetype of this GameObject.
    
    See Also:
    
    BaseObject.getArchetype()
  - hasUndefinedArchetype
```
public boolean hasUndefinedArchetype()
```
    Return whether this instance references an undefined archetype.
    
    Specified by:
    
    hasUndefinedArchetype in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    true if this instance references an undefined archetype
  - markModified
```
public void markModified()
```
    Marks this game object as "modified".
    
    Specified by:
    
    markModified in interface GameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Class AbstractGameObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Field Summary

Fields inherited from interface net.sf.gridarta.model.gameobject.GameObject

Fields inherited from interface net.sf.gridarta.model.baseobject.BaseObject

Constructor Summary

Method Summary

Methods inherited from class net.sf.gridarta.model.baseobject.AbstractBaseObject

Methods inherited from class net.sf.gridarta.model.baseobject.GameObjectContainer

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.gridarta.model.gameobject.GameObject

Methods inherited from interface net.sf.gridarta.model.baseobject.BaseObject

Methods inherited from interface net.sf.gridarta.model.baseobject.Attributes

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractGameObject

Method Detail

getAttributeString

getEffectiveFaceName

notifyBeginChange

notifyEndChange

notifyTransientChange

clone

asGameObject

newInstance

visit

remove

getContainer

isTop

isBottom

moveTop

moveUp

moveDown

moveBottom

insertBefore

insertAfter

getContainerGameObject

getTopContainer

setContainer

isInContainer

getMapSquare

getPrev

getNext

getArchetype

setArchetype

hasUndefinedArchetype

markModified