|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcage.graphics.Scene
public class Scene
A Scene is a collection of sprites and possibly an overlay which creates a scene in overall production.
Constructor Summary | |
---|---|
Scene(java.lang.String name)
Creates a Scene with the specified name. |
Method Summary | |
---|---|
void |
addBinding(java.lang.Integer keyConst,
Binding bind)
Adds a binding to the bindings used for this scene. |
void |
addRoutine(java.lang.String name)
Adds an action to be called each engine clock tick for this scene. |
void |
addSprite(Sprite s)
Add the specified Sprite to the scene. |
java.util.Map<java.lang.Integer,Binding> |
getBindings()
Returns the map of all bindings on the Scene. |
java.util.LinkedList<Sprite> |
getGraphics()
Returns all of the sprites used in this scene |
java.lang.String |
getName()
Gets the name of the Scene |
Overlay |
getOverlay()
Searches the ResourceEngine for the overlay with this Scenes stored overlay name and returns it. |
java.lang.String |
getOverlayName()
Gets the overlay name for the Scene. |
java.util.Collection<cage.carl.Closure> |
getRoutines()
Returns a collection of all Closures to be called each engine tick when this scene is the current scene. |
Sprite |
getSprite(java.lang.String name)
Looks for a sprite with the given name in the scene and returns it if found. |
java.lang.String |
getStartActionName()
The name of the action to call when this scene is made the currentScene |
void |
removeBinding(java.lang.Integer keyConst)
Remove a binding from the bindings used for this scene. |
void |
removeRoutine(java.lang.String name)
Remove the specifed routine from this scene |
void |
setOverlayName(java.lang.String overlayName)
Sets the name of the Overlay resource to be loaded when this scene is displayed. |
void |
setStartActionName(java.lang.String startActionName)
Sets the action name to call when this scene is made current. |
java.lang.String |
toString()
|
java.lang.String |
toXML()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Scene(java.lang.String name)
name
- The name of the scene.Method Detail |
---|
public void setOverlayName(java.lang.String overlayName)
overlayName
- The name of the Overlay resource.public java.lang.String getOverlayName()
public Overlay getOverlay()
public java.lang.String getName()
public java.lang.String getStartActionName()
public void setStartActionName(java.lang.String startActionName)
startActionName
- the name of the action to call.public java.util.LinkedList<Sprite> getGraphics()
public void addSprite(Sprite s)
s
- the Sprite to add.public Sprite getSprite(java.lang.String name)
name
- The name of the Sprite to search for.
public void addBinding(java.lang.Integer keyConst, Binding bind)
keyConst
- the value of the key the bind is forbind
- the Binding for the key value.public void removeBinding(java.lang.Integer keyConst)
keyConst
- the value of the key the bind is forpublic java.util.Map<java.lang.Integer,Binding> getBindings()
public void addRoutine(java.lang.String name)
name
- the name of the action to addpublic void removeRoutine(java.lang.String name)
name
- the name of the routine to removepublic java.util.Collection<cage.carl.Closure> getRoutines()
public java.lang.String toXML()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |