Blu Text Game Engine

The Free Open-Source Text-Game Engine!

Home :: Forums :: Download :: Source :: Documentation :: Donate

---

Documentation

Lua :: Standard Functions :: IrrKlang Functions

---

Folder Structure : To Top
When building a game with the TGE you have to follow a specific folder structure.
Lua files go into the ../lua/ directory and Sounds go into the ../sound/ directory.

Lua : To Top
The Text-Game Engine supports all Lua Standard libraries by default.


Standard Functions : To Top
Below are the built-in Functions.

NewLine()
Returns Type - none
Description: Breaks to a new line.

include( String filename)
Returns Type - none
Description: Includes another lua file in your code.

In()
Returns Type - String
Description: Takes input form the Console.

Out( String text)
Returns Type - none
Description: Outputs text to the Console.

Pause()
Returns Type - none
Description: Pauses the console and waits for input.


IrrKlang Functions : To Top
Below are the IrrKlang Functions.

sound.newSoundEngine()
Returns Type - SoundEngine
Description: Creates a new Sound Engine Instance.

sound.playSoundLooped( SoundEngine se, String filename)
Returns Type - none
Description: Plays a looped sound.

sound.stopSound( SoundEngine se, String filename)
Returns Type - none
Description: Stops a sound.

sound.stopAllSounds( SoundEngine se)
Returns Type - none
Description: Stops all sounds.

sound.dropSoundEngine( SoundEngine se)
Returns Type - none
Description: Deletes the Sound Engine form the Memory.

---