Drag[en]gine Script Module DragonScript Script API  1.0
PreloadAnnouncer Class Reference

Preload announcer. More...

Inheritance diagram for PreloadAnnouncer:
Preloader

Classes

class  PartSoundFinishedListener
 Preload part sound listener. More...
 

Public Member Functions

void finishPreloading ()
 Finish preloading. More...
 
Announcer getAnnouncer ()
 Dynamic sound to preload. More...
 
PreloadAnnouncer new (Announcer dynamicSound)
 Create preloader. More...
 
- Public Member Functions inherited from Preloader
void addListener (PreloadListener listener)
 Add listener. More...
 
void checkFinished ()
 Check if preloading finished. More...
 
void finishPreloading ()
 Finish preloading. More...
 
int getFinishedResourceCount ()
 Number of finished resources. More...
 
bool getPreloading ()
 Preloading. More...
 
bool getSuccess ()
 All resources preloaded successfully. More...
 
int getTotalResourceCount ()
 Total number of resources to preload. More...
 
void incrementTotalResourceCount ()
 Increment total resource count by one. More...
 
Preloader new ()
 Create preloader. More...
 
void notifyAllPreloadingFinished ()
 Notify listeners preloading finished. More...
 
void notifyAllResourcesFinished ()
 Notify listeners resources finished preloading. More...
 
float percentageFinished ()
 Percentage of resources finished preloading. More...
 
void removeListener (PreloadListener listener)
 Remove listener. More...
 
void resourceFinished (bool success)
 Resource finished preloading. More...
 

Detailed Description

Preload announcer.

Preloads sound files and finishes the announcer once all resources are loaded. To use create preloader and add one or more listeners to them. Once ready to preload call startPreloading().

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ finishPreloading()

void finishPreloading ( )

Finish preloading.

§ getAnnouncer()

Announcer getAnnouncer ( )

Dynamic sound to preload.

§ new()

PreloadAnnouncer new ( Announcer  dynamicSound)

Create preloader.


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