Playing Sounds. - Revision history

Tonyhilliam at 02:07, 17 January 2018

2018-01-17T02:07:18Z

← Older revision		Revision as of 02:07, 17 January 2018
Line 63:		Line 63:

	Next Tutorial: [[Hiding Meshes.]]<br>		Next Tutorial: [[Hiding Meshes.]]<br>

			[[Getting_Started_in_TrainzScript\|Back to Getting Started]]

Pcas1986: Call to PlaySound for TS12 does not work as written.

2011-09-06T05:18:34Z

Call to PlaySound for TS12 does not work as written.

← Older revision		Revision as of 05:18, 6 September 2011
Line 58:		Line 58:
	};		};

	I've used ''World.Play2DSound()'' to ring the bell because you will hear it no matter how far away from the shed the camera is zoomed. It would actually be more appropriate to use a different method, ''World.PlaySound()'' which will appear to come from one speaker or the other, depending on where you are, and will fall off in volume as you get further away from the building. The call for this would be <font color=blue>''World.PlaySound(me,"bell.wav",1000,10,100,me,"a.corona");''</font> You might like to try a substitution to hear the difference.<br><br>		I've used ''World.Play2DSound()'' to ring the bell because you will hear it no matter how far away from the shed the camera is zoomed. It would actually be more appropriate to use a different method, ''World.PlaySound()'' which will appear to come from one speaker or the other, depending on where you are, and will fall off in volume as you get further away from the building. The call for this would be <font color=blue>''World.PlaySound(me,"bell.wav",1000,10,100,me,"a.corona");''</font> (See Note 1) You might like to try a substitution to hear the difference.<br><br>

			Note 1. If you get a compiler error for this call, try ''World.PlaySound(GetAsset(),"bell.wav",1000.0,10.0,100.0,me,"a.corona").'' There were some changes for TS12 that may prevent the original code from working.

	Next Tutorial: [[Hiding Meshes.]]<br>		Next Tutorial: [[Hiding Meshes.]]<br>

Pw3r at 02:09, 27 April 2011

2011-04-27T02:09:03Z

← Older revision		Revision as of 02:09, 27 April 2011
Line 25:		Line 25:
	loop to monitor this variable and will keep running until ''doorsOpen'' becomes false.		loop to monitor this variable and will keep running until ''doorsOpen'' becomes false.
	''World.Play2DSound()'' plays a non-positional sound, that is it can be heard anywhere		''World.Play2DSound()'' plays a non-positional sound, that is it can be heard anywhere
	on the route. I've added a ~~short pause~~ after the sound is played, enough time to allow the		on the route. I've added a call to Sleep after the sound is played, enough time to allow the
	sound to play, plus a short pause. On the next loop the method will check to see if the doors		sound to play, plus a short pause. On the next loop the method will check to see if the doors
	are still open and run again if so. Once they have closed the ''while'' loop and the method		are still open and run again if so. Once they have closed the ''while'' loop and the method

Pw3r at 02:08, 27 April 2011

2011-04-27T02:08:08Z

← Older revision		Revision as of 02:08, 27 April 2011
Line 26:		Line 26:
	''World.Play2DSound()'' plays a non-positional sound, that is it can be heard anywhere		''World.Play2DSound()'' plays a non-positional sound, that is it can be heard anywhere
	on the route. I've added a short pause after the sound is played, enough time to allow the		on the route. I've added a short pause after the sound is played, enough time to allow the
	sound to play, plus a short pause. On the next loop the ~~mothod~~ will check to see if the doors		sound to play, plus a short pause. On the next loop the method will check to see if the doors
	are still open. Once they have closed the ''while'' loop and the method will end. All of this		are still open and run again if so. Once they have closed the ''while'' loop and the method
	runs independently of other parts of the class code. */</font>		will end. All of this runs independently of other parts of the class code. */</font>

	<font color=blue>thread void RingTheBell(void) {		<font color=blue>thread void RingTheBell(void) {

Pw3r at 02:07, 27 April 2011

2011-04-27T02:07:38Z

← Older revision		Revision as of 02:07, 27 April 2011
Line 24:		Line 24:
	which is set to true or false in the ''ObjectHandler'' method. ''RingTheBell'' uses a ''while''		which is set to true or false in the ''ObjectHandler'' method. ''RingTheBell'' uses a ''while''
	loop to monitor this variable and will keep running until ''doorsOpen'' becomes false.		loop to monitor this variable and will keep running until ''doorsOpen'' becomes false.
	''World.Play2DSound()'' plays a sound ~~file and returns~~ the ~~length of the file in seconds~~.		''World.Play2DSound()'' plays a non-positional sound, that is it can be heard anywhere
	I've added a short pause ~~to this and~~ the ~~overall result~~ is ~~that~~ the ~~method waits until~~		on the route. I've added a short pause after the sound is played, enough time to allow the
	~~the file has played~~, ~~waits~~ a short ~~while longer, and then goes back to~~ the ~~beginning~~ to		sound to play, plus a short pause. On the next loop the mothod will check to see if the doors
	see if the doors are still open. Once they have closed the ''while'' loop and the method		are still open. Once they have closed the ''while'' loop and the method will end. All of this
	will end. All of this runs independently of other parts of the class code. */</font>		runs independently of other parts of the class code. */</font>

	<font color=blue>thread void RingTheBell(void) {		<font color=blue>thread void RingTheBell(void) {
	while (doorsOpen) {		while (doorsOpen) {
	~~Sleep(0.35 +~~ World.Play2DSound(GetAsset(),"bell.wav"));		World.Play2DSound(GetAsset(),"bell.wav");
			Sleep(1.5);
	}		}
	}</font>		}</font>

Windwalkr: 1 revision

2010-02-03T13:59:37Z

1 revision

← Older revision	Revision as of 13:59, 3 February 2010
(No difference)

Andi06 at 20:58, 13 July 2008

2008-07-13T20:58:44Z

New page

Trainz is capable of doing quite sophisticated tricks with sound files. We will use a file which contains a single 'ding' but loops it around continuously as long as the doors to the shed are open. This involves the use of a separate programming ''thread''. A thread runs independently of any other code within your script. It's a bit like leaving the kettle boiling while you answer the front door, the kettle will look after itself until it boils. In the same way our thread will look after itself until something tells it to stop.

include "Buildable.gs"

class Tutorial isclass Buildable {

bool doorsOpen = false;

public void Init(void) {
inherited();
SetFXCoronaTexture("corona",null);
AddHandler(me,"Object","","ObjectHandler");
}

Asset GetCorona(string mesh, string effect) {
Soup meshtable = GetAsset().GetConfigSoup().GetNamedSoup("mesh-table");
Soup effects = meshtable.GetNamedSoup(mesh).GetNamedSoup("effects");
KUID kuid = effects.GetNamedSoup(effect).GetNamedTagAsKUID("texture-kuid");
return World.FindAsset(kuid);
}

/* This is the bell ringing method, the keyword ''thread'' signifies that it is to run
independently of any other code. You will remember our global variable, ''doorsOpen''
which is set to true or false in the ''ObjectHandler'' method. ''RingTheBell'' uses a ''while''
loop to monitor this variable and will keep running until ''doorsOpen'' becomes false.
''World.Play2DSound()'' plays a sound file and returns the length of the file in seconds.
I've added a short pause to this and the overall result is that the method waits until
the file has played, waits a short while longer, and then goes back to the beginning to
see if the doors are still open. Once they have closed the ''while'' loop and the method
will end. All of this runs independently of other parts of the class code. */

thread void RingTheBell(void) {
while (doorsOpen) {
Sleep(0.35 + World.Play2DSound(GetAsset(),"bell.wav"));
}
}

/* When the doors are opened we call the thread ''RingTheBell'' to start the bell ringing.
There is no need to stop it, this will happen automatically. */

void ObjectHandler(Message msg) {
Vehicle vehicle = cast<Vehicle>msg.src;
if (!vehicle) return;
if (msg.minor == "InnerEnter") {
doorsOpen = true;
SetMeshAnimationState("default", true);
SetFXCoronaTexture("corona",GetCorona("default","corona"));
RingTheBell();
}
else if (msg.minor == "InnerLeave") {
doorsOpen = false;
SetMeshAnimationState("default", false);
SetFXCoronaTexture("corona",null);
}
}

};

I've used ''World.Play2DSound()'' to ring the bell because you will hear it no matter how far away from the shed the camera is zoomed. It would actually be more appropriate to use a different method, ''World.PlaySound()'' which will appear to come from one speaker or the other, depending on where you are, and will fall off in volume as you get further away from the building. The call for this would be ''World.PlaySound(me,"bell.wav",1000,10,100,me,"a.corona");'' You might like to try a substitution to hear the difference. 
Next Tutorial: [[Hiding Meshes.]]