SndComponent.c

Go to the documentation of this file.

/*
===========================================
Do not modify, this script is generated
===========================================
*/

 
class SndComponent: GenericComponent
{
    proto external protected void SetCallbackMask(SndComponentCallbacks mask);
    proto external protected void SetForceUpdate(bool forceUpdate);
    proto external protected void SetDisableUpdate(bool forceUpdate);
    /* Component owner. */
    proto external IEntity GetOwner();
    /* Plays sound for given name. */
    proto external AudioHandle PlayStr(string name);
    /* Obsolete Returns the index of the given event name or -1 if not found */
    proto external int GetEventIndex(string name);
    /* Beginning of sound event scope. */
    [Obsolete("Not supported, will be removed!")]
    proto external int SoundEventBegin(string eventName);
    /* Sets scope parameters and plays the event. */
    [Obsolete("Not supported, will be removed!")]
    proto external int SoundEventEnd(int eventBeginId);
    proto external int GetSignalIndex(string name);
    proto external void SetSignalValue(int signal, float value);
    /* Sets signal value by name. */
    proto external void SetSignalValueStr(string signal, float value);
    /* Set transformation of all sounds played by this component */
    proto external void SetTransformation(vector transf[]);
    /* Set transformation of the sound associated with the given handle */
    proto external void SetSoundTransformation(AudioHandle handle, vector transf[]);
    /* Update playback of triggered sounds */
    proto external void UpdateTrigger();
    /* Terminate the sound associated with the given handle */
    proto external void Terminate(AudioHandle handle);
    /* Terminate all playing sounds associated with this component */
    proto external void TerminateAll();
    /* Check if any sound playing on this component */
    proto external bool IsPlaying();
    /* Check if sound associated with given handle has finished playing */
    proto external bool IsFinishedPlaying(AudioHandle handle);
    /* Returns true if handle is valid. */
    proto external bool IsHandleValid(AudioHandle handle);
    /* Fills the given array with the names of all signals found in this component*/
    proto external void GetSignalNames(out array<string> signalNames);
 
    // callbacks

    event protected void Update(float dt);
    event protected void OnUpdateBegin();
    event protected void OnUpdateEnd();
    event protected void OnInit(IEntity owner);
    event protected void OnPostInit(IEntity owner);
    event protected void OnDelete(IEntity owner);
}