net.sf.gridarta.model.baseobject

Class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,T extends BaseObject<G,A,R,T>>

java.lang.Object

net.sf.gridarta.model.baseobject.GameObjectContainer<G,A,R>

net.sf.gridarta.model.baseobject.AbstractBaseObject<G,A,R,T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractArchetype, AbstractGameObject

public abstract class AbstractBaseObject<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,T extends BaseObject<G,A,R,T>>
extends GameObjectContainer<G,A,R>
implements BaseObject<G,A,R,T>

Default implementation for GameObject implementing classes. This abstract class serves as a common base for GameObjects for Daimonin and Crossfire to allow classes that use GameObjects being reused and moved to Gridarta.

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	AbstractBaseObject(FaceObjectProviders faceObjectProviders, AnimationObjects animationObjects) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addMsgTextLine(java.lang.String text) Adds a line of message text.
void	addObjectText(java.lang.String line) Appends text to the object text of this GameObject.
void	addTailPart(T tail) Appends a tail to this GameObject.
protected void	beginGameObjectChange() Records that this game object is about to change.
T	clone()
int	countInvObjects() Counts the number of all inventory items (recursively).
protected void	endGameObjectChange() Records that this game object has changed.
void	facesReloaded() Will be called whenever the archetype faces have been reloaded.
java.lang.String	getAnimName() DaiEditor only: Returns the name of the animation.
double	getAttributeDouble(java.lang.String attributeName) Returns an attribute value of this Archetype as double.
double	getAttributeDouble(java.lang.String attributeName, boolean queryArchetype) Returns the requested attribute value of this GameObject as double.
int	getAttributeInt(java.lang.String attributeName) Returns an attribute value of this Archetype as int.
int	getAttributeInt(java.lang.String attributeName, boolean queryArchetype) Returns the requested attribute value of this GameObject as int.
java.util.Collection<java.lang.String>	getAttributeKeys() Returns all attribute keys of this object.
long	getAttributeLong(java.lang.String attributeName) Returns an attribute value of this Archetype as long.
long	getAttributeLong(java.lang.String attributeName, boolean queryArchetype) Returns the requested attribute value of this GameObject as long.
java.lang.String	getAttributeString(java.lang.String attributeName) Returns the requested attribute value of this GameObject as String.
protected java.lang.String	getAttributeValue(java.lang.String attributeName) Returns an attribute value by attribute name.
java.lang.String	getBestName() Returns the name which is best appropriate to describe this GameObject.
int	getDirection() Returns the direction of this Archetype or GameObject.
int	getEditType() Returns the edit type.
protected abstract java.lang.String	getEffectiveFaceName(java.lang.String faceName) Returns the effective face name for faceName for a given real face name.
java.lang.String	getFaceName() Returns the name of the face of this Archetype or GameObject.
java.lang.String	getFaceObjName() Returns the face name, can be from animation or face.
FaceSource	getFaceObjSource() Returns the FaceSource of this base object.
T	getHead() Return the head part of a multi-part object.
java.lang.String	getLoreText() Returns the map lore.
java.awt.Point	getMapLocation() Returns the coordinate of this GameObject on its map.
int	getMapX() Returns the X coordinate of this GameObject on its map.
int	getMapY() Returns the Y coordinate of this GameObject on its map.
int	getMaxX() Determines the maximum x-coordinate of any part relative to the head part.
int	getMaxY() Determines the maximum y-coordinate of any part relative to the head part.
int	getMinX() Determines the minimum x-coordinate of any part relative to the head part.
int	getMinY() Determines the minimum y-coordinate of any part relative to the head part.
java.lang.String	getMsgText() Returns the message bound to this object.
protected MultiArchData<G,A,R,T>	getMulti() Returns the MultiArchData for this base object.
T	getMultiNext() Returns the next of this multi-part object.
int	getMultiRefCount() Returns the number of parts for multi-part heads.
javax.swing.ImageIcon	getNormalImage() Returns the normal face for this GameObject.
java.lang.String	getObjectText() Returns the object text of this GameObject as String.
java.lang.String	getObjName() Returns the name of the object as shown to the player.
int	getSizeX() Determines the horizontal extent in squares.
int	getSizeY() Determines the vertical extent in squares.
protected abstract T	getThis() Returns this as its real type.
int	getTypeNo() Returns the type number of this Archetype.
boolean	hasAttribute(java.lang.String attributeName) Returns whether an attribute name exists.
boolean	hasAttribute(java.lang.String attributeName, boolean queryArchetype) Returns whether an attribute name exists.
boolean	isDefaultGameObject() Returns whether this game object is unmodified from its underlying archetype.
boolean	isEqual(BaseObject<?,?,?,?> gameObject) Compares this object to another game object.
boolean	isHead() Returns whether this object is a single-part object or the head of the multi-part object.
boolean	isMulti() Returns whether this Archetype is a multi-part object.
boolean	isTail() Determines if this part is a tail part.
abstract void	notifyBeginChange() Notify the map model that this container is about to change.
abstract void	notifyEndChange() Notify the map model that this container has changed.
void	removeAttribute(java.lang.String attributeName) Removes the String of an archetype attribute from the objectText.
void	removeTailParts() Removes all tail parts of this game object.
void	setAttributeInt(java.lang.String attributeName, int value) Sets an int value attribute.
void	setAttributeString(java.lang.String attributeName, java.lang.String value) Sets the String of an archetype attribute in the objectText.
void	setEditType(int editType) Sets the edit type.
void	setLoreText(java.lang.CharSequence loreText) Sets the map lore.
void	setMapX(int mapX) Sets the X coordinate of this GameObject on its map.
void	setMapY(int mapY) Sets the Y coordinate of this GameObject on its map.
void	setMsgText(java.lang.String msgText) Sets the message text.
void	setMulti(MultiArchData<G,A,R,T> multi)
void	setObjectFace() We set here the real face of the objects, depending on the set face and the set animation.
void	setObjectText(java.lang.String objectText) Sets objectText as object text of this GameObject.
protected void	setThisContainer(G gameObject) Sets a GameObject's container to this container.
java.lang.String	toString(java.lang.String format) Returns a string representation of this game object.
protected void	transientGameObjectChange() Records that this game object has changed but need not be restored by undo/redo actions.
protected void	updateArchetype() Called whenever BaseObject.getArchetype() has changed.

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

addFirst, addLast, asGameObject, getFirst, getLast, getMapSquare, 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.baseobject.BaseObject

getArchetype, getAttributeString, newInstance, notifyTransientChange, usesDirection, visit

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

AbstractBaseObject

protected AbstractBaseObject(@NotNull
                             FaceObjectProviders faceObjectProviders,
                             @NotNull
                             AnimationObjects animationObjects)

Creates a new instance.

Parameters:

faceObjectProviders - the face object providers for looking up faces

animationObjects - the animation objects for looking up animations

Method Detail

getTypeNo

public int getTypeNo()

Returns the type number of this Archetype.

Specified by:

getTypeNo in 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>>

Returns:

the type number of this archetype

getEffectiveFaceName

@Nullable
protected abstract java.lang.String getEffectiveFaceName(@NotNull
                                                                   java.lang.String faceName)

Returns the effective face name for faceName for a given real face name.

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

getFaceName

@Nullable
public java.lang.String getFaceName()

Returns the name of the face of this Archetype or GameObject.

Specified by:

getFaceName in 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>>

Returns:

the name of the face of this archetype or game object

countInvObjects

public int countInvObjects()

Counts the number of all inventory items (recursively). The returned value does not include this GameObject.

Specified by:

countInvObjects in 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>>

Returns:

the number of objects in the inventory (recursively)

hasAttribute

public boolean hasAttribute(@NotNull
                            java.lang.String attributeName,
                            boolean queryArchetype)

Returns whether an attribute name exists.

Specified by:

hasAttribute in 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>>

Parameters:

attributeName - the attribute name

queryArchetype - whether to query the Archetype of this GameObject: true if the Archetype should be queried as well, false to ignore it.

Returns:

whether the attribute name exists

hasAttribute

public boolean hasAttribute(@NotNull
                            java.lang.String attributeName)

Returns whether an attribute name exists.

Specified by:

hasAttribute in interface Attributes

Parameters:

attributeName - the attribute name

Returns:

whether the attribute name exists

getAttributeValue

@Nullable
protected java.lang.String getAttributeValue(@NotNull
                                                       java.lang.String attributeName)

Returns an attribute value by attribute name.

Parameters:

attributeName - the attribute name

Returns:

the attribute value or null

getAttributeString

@NotNull
public java.lang.String getAttributeString(@NotNull
                                                    java.lang.String attributeName)

Returns the requested attribute value of this GameObject as String. The attribute value is first searched in this GameObject. 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 Attributes

Parameters:

attributeName - the name of the attribute to search

Returns:

the attribute value or an empty String ("") if no such attribute

getAttributeInt

public int getAttributeInt(@NotNull
                           java.lang.String attributeName,
                           boolean queryArchetype)

Returns the requested attribute value of this GameObject as int.

Specified by:

getAttributeInt in 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>>

Parameters:

attributeName - the name of the attribute to search

queryArchetype - whether to query the archetype of this game object

Returns:

attribute the value or zero if not found

See Also:

Attributes.getAttributeInt(String), BaseObject.getAttributeString(String, boolean)

getAttributeInt

public int getAttributeInt(@NotNull
                           java.lang.String attributeName)

Returns an attribute value of this Archetype as int.

Specified by:

getAttributeInt in interface Attributes

Parameters:

attributeName - the name of the attribute value to return

Returns:

the attribute value or 0 (zero) if not found

See Also:

Attributes.getAttributeString(String)

getAttributeLong

public long getAttributeLong(@NotNull
                             java.lang.String attributeName,
                             boolean queryArchetype)

Returns the requested attribute value of this GameObject as long.

Specified by:

getAttributeLong in 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>>

Parameters:

attributeName - the name of the attribute to search

queryArchetype - whether to query the archetype of this game object

Returns:

the attribute value or zero if not found

See Also:

Attributes.getAttributeLong(String), BaseObject.getAttributeString(String, boolean)

getAttributeLong

public long getAttributeLong(@NotNull
                             java.lang.String attributeName)

Returns an attribute value of this Archetype as long.

Specified by:

getAttributeLong in interface Attributes

Parameters:

attributeName - the name of the attribute value to return

Returns:

the attribute value or 0 (zero) if not found

See Also:

Attributes.getAttributeString(String)

getAttributeDouble

public double getAttributeDouble(@NotNull
                                 java.lang.String attributeName,
                                 boolean queryArchetype)

Returns the requested attribute value of this GameObject as double.

Specified by:

getAttributeDouble in 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>>

Parameters:

attributeName - the name of the attribute to search

queryArchetype - whether to query the archetype of this game object

Returns:

the attribute value or zero if not found

See Also:

Attributes.getAttributeDouble(String), BaseObject.getAttributeString(String, boolean)

getAttributeDouble

public double getAttributeDouble(@NotNull
                                 java.lang.String attributeName)

Returns an attribute value of this Archetype as double.

Specified by:

getAttributeDouble in interface Attributes

Parameters:

attributeName - the name of the attribute value to return

Returns:

the attribute value or 0.0 (zero) if not found

See Also:

Attributes.getAttributeString(String)

setAttributeString

public void setAttributeString(@NotNull
                               java.lang.String attributeName,
                               @NotNull
                               java.lang.String value)

Sets the String of an archetype attribute in the objectText.

Specified by:

setAttributeString in 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>>

Parameters:

attributeName - search for "attributeName <string>"

value - the value to set

setAttributeInt

public void setAttributeInt(@NotNull
                            java.lang.String attributeName,
                            int value)

Sets an int value attribute.

Specified by:

setAttributeInt in interface Attributes

Parameters:

attributeName - the name of the attribute to update

value - the new value

removeAttribute

public void removeAttribute(@NotNull
                            java.lang.String attributeName)

Removes the String of an archetype attribute from the objectText.

Specified by:

removeAttribute in interface Attributes

Parameters:

attributeName - search for "attributeName <string>"

notifyBeginChange

public abstract 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>,T extends BaseObject<G,A,R,T>>

Specified by:

notifyBeginChange in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

No Inspection:

AbstractMethodOverridesAbstractMethod // needed because of public modifier

notifyEndChange

public abstract 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>,T extends BaseObject<G,A,R,T>>

Specified by:

notifyEndChange in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

No Inspection:

AbstractMethodOverridesAbstractMethod // needed because of public modifier

updateArchetype

protected void updateArchetype()

Called whenever BaseObject.getArchetype() has changed.

getEditType

public int getEditType()

Returns the edit type.

Specified by:

getEditType in 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>>

Returns:

the edit type

setEditType

public void setEditType(int editType)

Sets the edit type.

Specified by:

setEditType in 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>>

Parameters:

editType - the edit type

addMsgTextLine

public void addMsgTextLine(@NotNull
                           java.lang.String text)

Adds a line of message text. This is used when creating the GameObject from the ArchetypeParser.

Specified by:

addMsgTextLine in 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>>

Parameters:

text - the text to append to message text

getMsgText

@Nullable
public java.lang.String getMsgText()

Returns the message bound to this object. If the message is empty, the empty String is returned. If the object has no message, this method returns null.

Specified by:

getMsgText in 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>>

Returns:

the message bound to this object

setMsgText

public void setMsgText(@Nullable
                       java.lang.String msgText)

Sets the message text.

Specified by:

setMsgText in 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>>

Parameters:

msgText - the message text

getMapX

public int getMapX()

Returns the X coordinate of this GameObject on its map. This method only guarantees a reasonable value for GameObjects that are directly bound to a map. Implementations may also return reasonable values for GameObjects inside containers, but they are not required to do so.

Specified by:

getMapX in 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>>

Returns:

the x coordinate on map

See Also:

BaseObject.getMapY()

getMapY

public int getMapY()

Returns the Y coordinate of this GameObject on its map. This method only guarantees a reasonable value for GameObjects that are directly bound to a map. Implementations may also return reasonable values for GameObjects inside containers, but they are not required to do so.

Specified by:

getMapY in 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>>

Returns:

the y coordinate on map

See Also:

BaseObject.getMapX()

getMapLocation

public java.awt.Point getMapLocation()

Returns the coordinate of this GameObject on its map. This method only guarantees a reasonable value for GameObjects that are directly bound to a map. Implementations may also return reasonable values for GameObjects inside containers, but they are not required to do so.

Specified by:

getMapLocation in 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>>

Returns:

the coordinate on map

setMapX

public void setMapX(int mapX)

Sets the X coordinate of this GameObject on its map.

Specified by:

setMapX in 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>>

Parameters:

mapX - the x coordinate

setMapY

public void setMapY(int mapY)

Sets the Y coordinate of this GameObject on its map.

Specified by:

setMapY in 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>>

Parameters:

mapY - the y coordinate

isHead

public boolean isHead()

Returns whether this object is a single-part object or the head of the multi-part object.

Specified by:

isHead in 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>>

Returns:

true if single-part or head of multi-part, otherwise false

getMultiNext

@Nullable
public T getMultiNext()

Returns the next of this multi-part object.

Specified by:

getMultiNext in 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>>

Returns:

the next of this multi-part object or null if this isn't a multi-part object or this is the last part of a multi-part object

getMultiRefCount

public int getMultiRefCount()

Returns the number of parts for multi-part heads. (*.getMultiRefCount() > 0) is often used as way to find multi-parts.

Specified by:

getMultiRefCount in 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>>

Returns:

the number of parts

addTailPart

public void addTailPart(@NotNull
                        T tail)

Appends a tail to this GameObject.

Specified by:

addTailPart in 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>>

Parameters:

tail - the tail to append

removeTailParts

public void removeTailParts()

Removes all tail parts of this game object. Afterwards BaseObject.isMulti() will return false.

Specified by:

removeTailParts in 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>>

getHead

public T getHead()

Return the head part of a multi-part object. For single-part objects it is the object itself.

Specified by:

getHead in 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>>

Returns:

the head of the object

isTail

public boolean isTail()

Determines if this part is a tail part. For single-part objects this is never true.

Specified by:

isTail in 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>>

Returns:

true iff this part if a tail part

getSizeX

public int getSizeX()

Determines the horizontal extent in squares. For single-part objects 1 is returned.

Specified by:

getSizeX in 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>>

Returns:

the horizontal extent

getSizeY

public int getSizeY()

Determines the vertical extent in squares. For single-part objects 1 is returned.

Specified by:

getSizeY in 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>>

Returns:

the vertical extent

getMaxX

public int getMaxX()

Determines the maximum x-coordinate of any part relative to the head part. For single-part objects 0 is returned.

Specified by:

getMaxX in 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>>

Returns:

the maximum x-coordinate

getMaxY

public int getMaxY()

Determines the maximum y-coordinate of any part relative to the head part. For single-part objects 0 is returned.

Specified by:

getMaxY in 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>>

Returns:

the maximum y-coordinate

getMinX

public int getMinX()

Determines the minimum x-coordinate of any part relative to the head part. For single-part objects 0 is returned.

Specified by:

getMinX in 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>>

Returns:

the minimum x-coordinate

getMinY

public int getMinY()

Determines the minimum y-coordinate of any part relative to the head part. For single-part objects 0 is returned.

Specified by:

getMinY in 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>>

Returns:

the minimum y-coordinate

clone

@NotNull
public T clone()

Specified by:

clone in 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>>

Overrides:

clone in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

setThisContainer

protected void setThisContainer(@NotNull
                                G gameObject)

Sets a GameObject's container to this container.

Specified by:

setThisContainer in class GameObjectContainer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

gameObject - the game object

getObjName

@NotNull
public java.lang.String getObjName()

Returns the name of the object as shown to the player.

Specified by:

getObjName in 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>>

Returns:

the name of the object as shown to the player

getBestName

@NotNull
public java.lang.String getBestName()

Returns the name which is best appropriate to describe this GameObject. (This can be Archetype name or GameObject name.)

Specified by:

getBestName in 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>>

Returns:

the best suitable descriptive name

getObjectText

@NotNull
public java.lang.String getObjectText()

Returns the object text of this GameObject as String.

Specified by:

getObjectText in 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>>

Returns:

the object text

addObjectText

public void addObjectText(@NotNull
                          java.lang.String line)

Appends text to the object text of this GameObject.

Specified by:

addObjectText in 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>>

Parameters:

line - a line of text to append, may contain '\n' for appending multiple lines

setObjectText

public void setObjectText(@NotNull
                          java.lang.String objectText)

Sets objectText as object text of this GameObject.

Specified by:

setObjectText in 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>>

Parameters:

objectText - the text to set as object text

isDefaultGameObject

public boolean isDefaultGameObject()

Returns whether this game object is unmodified from its underlying archetype.

Specified by:

isDefaultGameObject in 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>>

Returns:

whether this game object is unmodified

isEqual

public boolean isEqual(@NotNull
                       BaseObject<?,?,?,?> gameObject)

Compares this object to another game object.

Specified by:

isEqual in 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>>

Parameters:

gameObject - the other game object

Returns:

true if this object equals the other object

getDirection

public int getDirection()

Returns the direction of this Archetype or GameObject.

Specified by:

getDirection in 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>>

Returns:

the direction of this archetype or game object

beginGameObjectChange

protected void beginGameObjectChange()

Records that this game object is about to change.

endGameObjectChange

protected void endGameObjectChange()

Records that this game object has changed.

transientGameObjectChange

protected void transientGameObjectChange()

Records that this game object has changed but need not be restored by undo/redo actions.

getFaceObjSource

@NotNull
public FaceSource getFaceObjSource()

Returns the FaceSource of this base object.

Specified by:

getFaceObjSource in 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>>

Returns:

the face source

getAnimName

@Nullable
public java.lang.String getAnimName()

DaiEditor only: Returns the name of the animation.

Specified by:

getAnimName in 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>>

Returns:

the name of the animation

isMulti

public boolean isMulti()

Returns whether this Archetype is a multi-part object.

Specified by:

isMulti in 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>>

Returns:

true if this Archetype is a multi-part object, otherwise false

getMulti

@Nullable
protected MultiArchData<G,A,R,T> getMulti()

Returns the MultiArchData for this base object.

Returns:

the multi arch data or null if this object is not a multi-square object

setMulti

public void setMulti(@NotNull
                     MultiArchData<G,A,R,T> multi)

Specified by:

setMulti in 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>>

getFaceObjName

@Nullable
public java.lang.String getFaceObjName()

Returns the face name, can be from animation or face.

Specified by:

getFaceObjName in 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>>

Returns:

the face name

setObjectFace

public void setObjectFace()

We set here the real face of the objects, depending on the set face and the set animation. The rule is, that a active animation will overrule the default face. We will catch it here. This method should always be invoked after the face or animation has changed and no other change is expected right now, so the changes to animation / face should be applied.

Specified by:

setObjectFace in 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>>

getNormalImage

@NotNull
public javax.swing.ImageIcon getNormalImage()

Returns the normal face for this GameObject.

Specified by:

getNormalImage in 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>>

Returns:

the normal face for this GameObject

getLoreText

@NotNull
public java.lang.String getLoreText()

Returns the map lore.

Specified by:

getLoreText in 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>>

Returns:

the map lore

setLoreText

public void setLoreText(@NotNull
                        java.lang.CharSequence loreText)

Sets the map lore.

Specified by:

setLoreText in 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>>

Parameters:

loreText - the map lore

facesReloaded

public void facesReloaded()

Will be called whenever the archetype faces have been reloaded.

Specified by:

facesReloaded in 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>>

toString

@NotNull
public java.lang.String toString(@NotNull
                                          java.lang.String format)

Returns a string representation of this game object. The string representation is the given format string which supports the following replacements:

• $$ - a string $ character
• ${NAME} - the in-game object name
• ${name} - the value of attribute "name"
• ${name:text} - text if the attribute name exists; empty otherwise. replacements within "text" are processed

Specified by:

toString in 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>>

Parameters:

format - the format to use

Returns:

the string representation

getThis

@NotNull
protected abstract T getThis()

Returns this as its real type.

Returns:

this

getAttributeKeys

@NotNull
public java.util.Collection<java.lang.String> getAttributeKeys()

Returns all attribute keys of this object.

Returns:

the attribute keys