comnik.warpsound: Functions Types Modinfo Source  

WarpSound Modul!

This modul adds sound Emitter and trigger to the BlitzMax Sound Functions. license: License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software And associated documentation files (the "Software"), To deal in" the Software without restriction, including without limitation the rights To use, copy, modify, merge, publish, distribute, sublicense, And/Or sell copies of the Software, And To permit persons To whom the Software is furnished To do so, subject To the following conditions:

The author Nikolas Göbel has To be by name mentioned."

Functions Summary

InRange Check if two distances "overlap"
WP_AddSoundTrigger Add a new Trigger.
WP_CreateSoundEmitter Create a sound emitter.
WP_UpdateSounds Update triggers and emitters.

Types Summary

WP_SoundEmitter Sound Emitter.
WP_SoundTrigger Sound Trigger.

Functions

Function InRange:Byte(x1:Float, y1:Float, x2:Float, y2:Float, dist:Float)
DescriptionCheck if two distances "overlap"

Function WP_AddSoundTrigger:WP_SoundTrigger(x:Float, y:Float, parent:WP_SoundEmitter)
ReturnsA Sound Trigger object.
DescriptionAdd a new Trigger.
InformationCreates a new trigger and returns it's handle.

Function WP_CreateSoundEmitter:WP_SoundEmitter(channel:TChannel, x:Float, y:Float, activation_distance:Float=800, MAXVOL:Float=1)
ReturnsA sound emitter object.
DescriptionCreate a sound emitter.

Function WP_UpdateSounds()
DescriptionUpdate triggers and emitters.

Types

Type WP_SoundEmitter
DescriptionSound Emitter.
InformationA sound emitter contains a channel, which he plays, If he gets activated by a trigger in his trigger list. If the trigger gets closer, the sound gets louder.
Methods Summary
kill Kill the Emitter.
WP_RemoveSoundTrigger Remove a Trigger.
Method kill()
DescriptionKill the Emitter.
InformationStops the Channel, and removes the Emitter.
Method WP_RemoveSoundTrigger(trigger:WP_SoundTrigger)
DescriptionRemove a Trigger.

Type WP_SoundTrigger
DescriptionSound Trigger.
InformationActivates his parent Emitter, if the distance between them is less than the activation distance of the emitter.

Module Information

FrameworkThis Module provides extended sound effects for BlitzMax.
AuthorNikolas 'ComNik' Göbel
LicenseFeel free to use the code as you like, but it would be nice to mention my name... ;)