LUA_API_Sound.h

Go to the documentation of this file.

// |      _                   ____         __ _   
// |     / \  _   _ _ __ __ _/ ___|  ___  / _| |_ 
// |    / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
// |   / ___ \ |_| | | | (_| |___) | (_) |  _| |_ 
// |  /_/   \_\__,_|_|  \__,_|____/ \___/|_|  \__|
// | 
// |  Aurasoft UK 2008 - 2018 http://www.aurasoft.co.uk
// | 
// |  Skyline Game Engine Lua API Documentation
// | 
// |    This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
// |    This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other 
// |    person outside of the Skyline Game Engine development team.
// |    
// | © Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2018
// |

// SKYLINE LUA CLASS FOR API DOCUMENTATION

class sound
{
public:

    void setLooped( int enableState );  


    void setVolume( float volume ); 

    void setPitch( float pitch );   


    void setSoundFile( string soundFilename );

    void setIsStreamed(int enableState);

    int createSound();

    void play2DSound( int soundID );

    void play3DSound( int soundID, float posX, float posY, float posZ );

    void stopSound( int soundID );
    
    int isPlaying( int soundID );

    void changePosition( int soundID, float posX, float posY, float posZ );

    void changeVolume( int soundID, float volume);
        
    void changePitch( int soundID, float pitch);

    void setRolloff(int soundID, float rolloff);

    void setMaxDistance(int soundID, float distance);       
    

    void setMinDistance(int soundID, float distance);       
    
    void freeSound( int soundID);

    sound.distanceAttenuation( int soundID, float minDistance, float maxDistance, float minimum, float maximum);

};