Gridarta Editor
net.sf.gridarta.model.anim.AnimationObject Interface Reference

An AnimationObject reflects the animation ("@code anim\n @endcode " ... More...

+ Inheritance diagram for net.sf.gridarta.model.anim.AnimationObject:
+ Collaboration diagram for net.sf.gridarta.model.anim.AnimationObject:

Public Member Functions

String getAnimList ()
 Returns the animation list of this animation. More...
 
String getAnimName ()
 Get the animName, which is the name of the animation as usable by the "animations" attribute. More...
 
int getFacings ()
 Get the facings, which is the number of different sub-animations, for instance for different directions. More...
 
String getFirstFrame (int facing)
 Get the first frame. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObject
String getDisplayIconName ()
 Returns the face name of the display icon for this AbstractNamedObject. More...
 
String getName ()
 Get the name of this AbstractNamedObject. More...
 
String getPath ()
 Get the path of this AbstractNamedObject. More...
 
void setPath (@NotNull String path)
 Set the path of this AbstractNamedObject. More...
 
String toString ()
 

Detailed Description

An AnimationObject reflects the animation ("@code anim\n @endcode " ...

"@code mina\n @endcode ") of a GameObject or Archetype.

Author
Christian Hujer

Definition at line 30 of file AnimationObject.java.

Member Function Documentation

◆ getAnimList()

String net.sf.gridarta.model.anim.AnimationObject.getAnimList ( )

Returns the animation list of this animation.

The individual entries are all suffixed with '
'.

Returns
the animation list of this animation

Implemented in net.sf.gridarta.model.anim.DefaultAnimationObject.

◆ getAnimName()

String net.sf.gridarta.model.anim.AnimationObject.getAnimName ( )

Get the animName, which is the name of the animation as usable by the "animations" attribute.

Returns
the name of this animation

Implemented in net.sf.gridarta.model.anim.DefaultAnimationObject.

Referenced by net.sf.gridarta.model.anim.DuplicateAnimationException.DuplicateAnimationException(), net.sf.gridarta.model.io.AbstractArchetypeParser< G, A, R, ?>.parseAnim(), and net.sf.gridarta.model.resource.AbstractFilesResourcesReaderTest.testAnimationPaths().

+ Here is the caller graph for this function:

◆ getFacings()

int net.sf.gridarta.model.anim.AnimationObject.getFacings ( )

Get the facings, which is the number of different sub-animations, for instance for different directions.

Returns
facings

Implemented in net.sf.gridarta.model.anim.DefaultAnimationObject.

◆ getFirstFrame()

String net.sf.gridarta.model.anim.AnimationObject.getFirstFrame ( int  facing)

Get the first frame.

Parameters
facingfacing to get frame for, usually a direction
Returns
frame

Implemented in net.sf.gridarta.model.anim.DefaultAnimationObject.

Referenced by net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.setObjectFace().

+ Here is the caller graph for this function:

The documentation for this interface was generated from the following file: