AbstractArchetype (Gridarta)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultArchetype, DefaultArchetype, DefaultArchetype, UndefinedArchetype, UndefinedArchetype, UndefinedArchetype
```
public abstract class AbstractArchetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends AbstractBaseObject<G,A,R,R>
implements Archetype<G,A,R>
```
Abstract base class for Archetype implementations.

See Also:

Serialized Form

Field Summary
- 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`	`AbstractArchetype(java.lang.String archetypeName, 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.
`R`	`clone()`
`R`	`getArchetype()` Returns the Archetype this GameObject is based on.
`java.lang.String`	`getArchetypeName()` Returns the name of this archetype.
`java.lang.String`	`getAttributeString(java.lang.String attributeName, boolean queryArchetype)` Returns the requested attribute value of this GameObject as `String`.
`java.lang.String`	`getEditorFolder()` Returns the editor folder.
`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.
`int`	`getMultiPartNr()` Returns the multi part id.
`int`	`getMultiShapeID()` Returns the multi shape id.
`int`	`getMultiX()` Returns the x-distance of this part to the head part.
`int`	`getMultiY()` Returns the y-distance of this part to the head part.
`boolean`	`isArtifact()` Returns whether this GameObject is an Artifact.
`boolean`	`isLowestPart()` Returns whether this part has the smallest y coordinate when painting the image.
`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`	`setArchetypeName(java.lang.String archetypeName)` Sets the name of this archetype.
`void`	`setArtifact()` Converts this game object into an artifact.
`void`	`setEditorFolder(java.lang.String editorFolder)` Set the editor folder.
`void`	`setLowestPart(boolean isLowestPart)` Sets whether this part has the smallest y coordinate when painting the image.
`void`	`setMultiPartNr(int multiPartNr)` Sets the multi part id.
`void`	`setMultiShapeID(int multiShapeID)` Sets the multi shape id.
`void`	`setMultiX(int multiX)` Sets the x-position of this part of a multi-part object.
`void`	`setMultiY(int multiY)` Sets the y-position of this part of a multi-part object.
`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.archetype.Archetype
addFirst, addLast, getAttributeKeys, isUndefinedArchetype, iterator

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
  - AbstractArchetype
```
protected AbstractArchetype(@NotNull
                            java.lang.String archetypeName,
                            @NotNull
                            FaceObjectProviders faceObjectProviders,
                            @NotNull
                            AnimationObjects animationObjects)
```
    Creates a new instance.
    
    Parameters:
    
    archetypeName - the name of the archetype
    
    faceObjectProviders - the face object providers for looking up faces
    
    animationObjects - the animation objects for looking up animations
- Method Detail
  - getMapSquare
```
@Nullable
public MapSquare<G,A,R> getMapSquare()
```
    Returns the MapSquare of this container.
    
    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)
  - 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>,R extends Archetype<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>,R extends Archetype<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>,R extends Archetype<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>,R extends Archetype<G,A,R>>
    
    No Inspection:
    
    NoopMethodInAbstractClass
  - 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>,R extends Archetype<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>,R extends Archetype<G,A,R>>
    
    No Inspection:
    
    NoopMethodInAbstractClass
  - 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>,R extends Archetype<G,A,R>>
    
    No Inspection:
    
    NoopMethodInAbstractClass
  - 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>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the archetype this game object is based on
  - clone
```
@NotNull
public R clone()
```
    Specified by:
    
    clone in interface BaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,R extends Archetype<G,A,R>>
    
    Overrides:
    
    clone in class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,R extends Archetype<G,A,R>>
  - asGameObject
```
@Nullable
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>,R extends Archetype<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>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    baseObjectVisitor - the base object visitor
  - getArchetypeName
```
@NotNull
public java.lang.String getArchetypeName()
```
    Returns the name of this archetype.
    
    Specified by:
    
    getArchetypeName in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the name
  - setArchetypeName
```
public void setArchetypeName(@NotNull
                             java.lang.String archetypeName)
```
    Sets the name of this archetype.
    
    Specified by:
    
    setArchetypeName in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    archetypeName - the name
  - setMultiX
```
public void setMultiX(int multiX)
```
    Sets the x-position of this part of a multi-part object. The x-position is relative to the head part.
    
    Specified by:
    
    setMultiX in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    multiX - the x-distance of this part to the head part
  - setMultiY
```
public void setMultiY(int multiY)
```
    Sets the y-position of this part of a multi-part object. The y-position is relative to the head part.
    
    Specified by:
    
    setMultiY in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    multiY - the y-distance of this part to the head part
  - getMultiX
```
public int getMultiX()
```
    Returns the x-distance of this part to the head part. For single-part objects this is always zero.
    
    Specified by:
    
    getMultiX in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the x-distance of this part to the head part
  - getMultiY
```
public int getMultiY()
```
    Returns the y-distance of this part to the head part. For single-part objects this is always zero.
    
    Specified by:
    
    getMultiY in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the y-distance of this part to the head part
  - isLowestPart
```
public boolean isLowestPart()
```
    Returns whether this part has the smallest y coordinate when painting the image.
    
    Specified by:
    
    isLowestPart in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    whether this part has the smallest y coordinate
  - setLowestPart
```
public void setLowestPart(boolean isLowestPart)
```
    Sets whether this part has the smallest y coordinate when painting the image.
    
    Specified by:
    
    setLowestPart in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    isLowestPart - whether this part has the smallest y coordinate
  - getMultiShapeID
```
public int getMultiShapeID()
```
    Returns the multi shape id.
    
    Specified by:
    
    getMultiShapeID in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the multi shape id
  - setMultiShapeID
```
public void setMultiShapeID(int multiShapeID)
```
    Sets the multi shape id.
    
    Specified by:
    
    setMultiShapeID in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    multiShapeID - the multi shape id
  - getMultiPartNr
```
public int getMultiPartNr()
```
    Returns the multi part id.
    
    Specified by:
    
    getMultiPartNr in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the multi part id
  - setMultiPartNr
```
public void setMultiPartNr(int multiPartNr)
```
    Sets the multi part id.
    
    Specified by:
    
    setMultiPartNr in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    multiPartNr - the multi part id
  - getEditorFolder
```
@Nullable
public java.lang.String getEditorFolder()
```
    Returns the editor folder.
    
    Specified by:
    
    getEditorFolder in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the editor folder
  - setEditorFolder
```
public void setEditorFolder(@Nullable
                            java.lang.String editorFolder)
```
    Set the editor folder.
    
    Specified by:
    
    setEditorFolder in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    editorFolder - the editor folder
  - isArtifact
```
public boolean isArtifact()
```
    Returns whether this GameObject is an Artifact. Artifacts are special forms of Archetypes, and they are excluded from Archetypes collection.
    
    Specified by:
    
    isArtifact in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    true if this GameObject is an Artifact, otherwise false.
  - setArtifact
```
public void setArtifact()
```
    Converts this game object into an artifact.
    
    Specified by:
    
    setArtifact in interface Archetype<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    See Also:
    
    Archetype.isArtifact()

Class AbstractArchetype<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.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.archetype.Archetype

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

AbstractArchetype

Method Detail

getMapSquare

getAttributeString

getEffectiveFaceName

notifyBeginChange

notifyEndChange

notifyTransientChange

getArchetype

clone

asGameObject

newInstance

visit

getArchetypeName

setArchetypeName

setMultiX

setMultiY

getMultiX

getMultiY

isLowestPart

setLowestPart

getMultiShapeID

setMultiShapeID

getMultiPartNr

setMultiPartNr

getEditorFolder

setEditorFolder

isArtifact

setArtifact