org.jrabbit.standard.intro
Interface Intro

All Superinterfaces:
Createable, Destroyable, Renderable, Updateable
All Known Implementing Classes:
BaseLogoIntro, ImageAudioIntro, ImageIntro, JRabbitIntro

public interface Intro
extends Updateable, Renderable, Createable, Destroyable

An Intro is an object that displays itself at the beginning of a game, to show some opening scene or message. Intro is designed to be as flexible as possible, so that virtually any opening can be created.

Author:
Chris Molini

Method Summary
 boolean finished()
          This method is used to determine if the Intro should stop playing and if the next one in the queue should be started.
 void start()
          This method is called when the Intro is begun being displayed.
 
Methods inherited from interface org.jrabbit.base.core.types.Updateable
update
 
Methods inherited from interface org.jrabbit.base.core.types.Renderable
render
 
Methods inherited from interface org.jrabbit.base.data.Createable
create
 
Methods inherited from interface org.jrabbit.base.data.Destroyable
destroy
 

Method Detail

start

void start()
This method is called when the Intro is begun being displayed. Any calls that should be made at the beginning of playback should be called here.


finished

boolean finished()
This method is used to determine if the Intro should stop playing and if the next one in the queue should be started.

Returns:
True if the Intro is finished, false if it should continue playing.