Play - Revision history

Asie: /* Notes and Rests */ document scientific pitch

2026-03-17T16:53:22Z

Notes and Rests: document scientific pitch

← Older revision		Revision as of 16:53, 17 March 2026
Line 34:		Line 34:
	\|}		\|}

	The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).		The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively), which corresponds to middle C.

	Note that the lengths are measured in PIT ticks, not cycles! The PIT ticks at approximately 18.2 Hz, meaning that a 32nd note lasts approximately 55 milliseconds.		Note that the lengths are measured in PIT ticks, not cycles! The PIT ticks at approximately 18.2 Hz, meaning that a 32nd note lasts approximately 55 milliseconds.
Line 46:		Line 46:
	** ''#'' - Sharp		** ''#'' - Sharp
	** ''!'' - Flat		** ''!'' - Flat
			Notes in ZZT are meant to be tuned to scientific pitch, with middle C equal to 256 Hz; however, rounding errors in the lowest and highest octaves cause some notes to be slightly out of tune.

	=== Drums ===		=== Drums ===

RT-55J: put in a proper stub template

2025-12-31T22:14:58Z

put in a proper stub template

← Older revision		Revision as of 22:14, 31 December 2025
Line 1:		Line 1:
	~~''[This article is a stub. You can help by filling it out.]''~~

	The '''#play''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.		The '''#play''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.

Line 78:		Line 76:

	== Examples ==		== Examples ==

			{{Template:Stub}}

	''[TODO: Put a simple thing here and explain it character by character.]''		''[TODO: Put a simple thing here and explain it character by character.]''

Asie: /* Quirks */

2025-12-24T15:20:10Z

Quirks

← Older revision		Revision as of 15:20, 24 December 2025
Line 95:		Line 95:
	* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.		* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.
	** The above also means that, on slower hardware, a drum playback actually stalls engine execution for the duration of its sound.		** The above also means that, on slower hardware, a drum playback actually stalls engine execution for the duration of its sound.
			* The sound buffer has a size limit of 255 bytes; as each queued sound (note + duration pair) takes up two bytes, this means there may be at most 127 different sounds queued up for playback.

	== See Also ==		== See Also ==

Asie at 15:16, 24 December 2025

2025-12-24T15:16:09Z

← Older revision		Revision as of 15:16, 24 December 2025
Line 5:		Line 5:
	== Syntax ==		== Syntax ==
	<code>#play <sound></code>		<code>#play <sound></code>

	~~== Sound Format ==~~

	The general syntax is that parameters come before the notes and drums they modify.		The general syntax is that parameters come before the notes and drums they modify.
Line 79:		Line 77:
	Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.		Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.

	== ~~Example~~ ==		== Examples ==

	''[TODO: Put a simple thing here and explain it character by character.]''		''[TODO: Put a simple thing here and explain it character by character.]''

	== Quirks ==		== Quirks ==

			=== Sound parser ===

	* When a scroll uses <code>#play</code> it does not suppress the default scroll sound effect. Rather, the sound is appended to the end of the sound effect.		* When a scroll uses <code>#play</code> it does not suppress the default scroll sound effect. Rather, the sound is appended to the end of the sound effect.
	* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.		* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.

			=== Sound playback ===

			* The note frequencies are calculated using scientific pitch, with C<sub>4</sub> equal to 256 Hz and A<sub>4</sub> theoretically equal to 430.54 Hz. However, inaccuracies are introduced in the frequency calculation process by the use of two turncation operations:
			** The first truncation removes the fractional component of the frequency; for example, A<sub>4</sub>, after truncation, is equal to 430 Hz.
			** The second truncation is applied inside Turbo Pascal's built-in ''Sound()'' function, when deriving the IBM PC's programmable interrupt timer period from the provided frequency. (TODO)
	* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.		* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.
	** The above also means that, on slower hardware, a drum playback actually stalls engine execution for the duration of its sound!		** The above also means that, on slower hardware, a drum playback actually stalls engine execution for the duration of its sound.

	== See Also ==		== See Also ==

Asie at 17:12, 29 September 2022

2022-09-29T17:12:55Z

← Older revision		Revision as of 17:12, 29 September 2022
Line 1:		Line 1:
	''[This article is a stub. You can help by filling it out.]''		''[This article is a stub. You can help by filling it out.]''

	The '''#play ~~[sound]~~''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.		The '''#play''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.

			== Syntax ==
			<code>#play <sound></code>

	== Sound Format ==		== Sound Format ==

RT-55J: organization mostly

2021-02-13T02:28:23Z

organization mostly

← Older revision		Revision as of 02:28, 13 February 2021
Line 5:		Line 5:
	== Sound Format ==		== Sound Format ==

	The general syntax is that parameters come before the notes and drums they modify. ~~The octave and length parameters~~ are ~~reset each line. The default note length is 1~~ (~~32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively~~).		The general syntax is that parameters come before the notes and drums they modify.

			All characters not listed below are silently ignored (like comments).

	=== Parameters ===		=== Parameters ===

	{\| class="wikitable"		{\| class="wikitable"
	~~\|+ Parameters~~
	\|-
	! Symbol !! Denotes !! Length in Ticks		! Symbol !! Denotes !! Length in Ticks
	\|-		\|-
Line 34:		Line 34:
	\| - \|\| Down octave \|\| N/A		\| - \|\| Down octave \|\| N/A
	\|}		\|}

			The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).

	Note that the lengths are measured in PIT ticks, not cycles! The PIT ticks at approximately 18.2 Hz, meaning that a 32nd note lasts approximately 55 milliseconds.		Note that the lengths are measured in PIT ticks, not cycles! The PIT ticks at approximately 18.2 Hz, meaning that a 32nd note lasts approximately 55 milliseconds.
Line 47:		Line 49:

	=== Drums ===		=== Drums ===

	Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.

	{\| class="wikitable"		{\| class="wikitable"
	~~\|+ Drums~~
	\|-
	! Symbol !! "Sound"		! Symbol !! "Sound"
	\|-		\|-
Line 76:		Line 74:
	\|}		\|}

	~~All other characters~~ are ~~silently ignored (like comments)~~.		Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.

			== Example ==

			''[TODO: Put a simple thing here and explain it character by character.]''

	== Quirks ==		== Quirks ==

	* When a scroll uses ~~'''~~#play~~'''~~ it does not suppress the default scroll sound effect.		* When a scroll uses <code>#play</code> it does not suppress the default scroll sound effect. Rather, the sound is appended to the end of the sound effect.
	* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.		* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.
	* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.		* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.

RT-55J: Moved the note about scrolls down to quirks. Added subheadings.

2021-02-12T19:54:17Z

Moved the note about scrolls down to quirks. Added subheadings.

← Older revision		Revision as of 19:54, 12 February 2021
Line 1:		Line 1:
	''[This article is a stub. You can help by filling it out.]''		''[This article is a stub. You can help by filling it out.]''

	The '''#play [sound]''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects. ~~(Note a scroll using '''#play''' does not suppress the default scroll sound effect.)~~		The '''#play [sound]''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.

	== Sound Format ==		== Sound Format ==

	The general syntax is that parameters come before the notes and drums they modify. The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).		The general syntax is that parameters come before the notes and drums they modify. The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).

			=== Parameters ===

	{\| class="wikitable"		{\| class="wikitable"
Line 37:		Line 39:
	The triplet and time-and-a-half modifiers need to be placed somewhere after the length parameters they are modifying (eg ''w3'' or ''h.''). These modifiers also stack (eg. ''w.3'' produces a 16-tick-long note length, equivalent to ''h'').		The triplet and time-and-a-half modifiers need to be placed somewhere after the length parameters they are modifying (eg ''w3'' or ''h.''). These modifiers also stack (eg. ''w.3'' produces a 16-tick-long note length, equivalent to ''h'').

	Notes and Rests:		=== Notes and Rests ===

	* ''X'' - Rest		* ''X'' - Rest
Line 43:		Line 45:
	** ''#'' - Sharp		** ''#'' - Sharp
	** ''!'' - Flat		** ''!'' - Flat

			=== Drums ===

	Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.		Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.
Line 76:		Line 80:
	== Quirks ==		== Quirks ==

			* When a scroll uses '''#play''' it does not suppress the default scroll sound effect.
	* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.		* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.
	* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.		* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.

Asie: style, factor out and document new quirks/duration/drum info

2021-02-12T17:33:33Z

style, factor out and document new quirks/duration/drum info

← Older revision		Revision as of 17:33, 12 February 2021
Line 33:		Line 33:
	\|}		\|}

	~~In order to work, the triplet and time-and-a-half modifiers need to be placed somewhere after~~ the ~~length parameters they~~ are ~~modifying (eg ''w3'' or ''h~~.~~''). Also~~, ~~these parameters can stack on each other (eg w3. produces~~ a ~~15-tick-long~~ note ~~length)~~.		Note that the lengths are measured in PIT ticks, not cycles! The PIT ticks at approximately 18.2 Hz, meaning that a 32nd note lasts approximately 55 milliseconds.

	The triplet and time-and-a-half parameters ~~use integer floor division. If the result of the division is 0~~ (~~with either~~ ''t3'' or ''s3'')~~, then the length value will underflow and ZZT will play~~ a ~~256~~-tick-long ~~notes (~25 seconds each~~).		The triplet and time-and-a-half modifiers need to be placed somewhere after the length parameters they are modifying (eg ''w3'' or ''h.''). These modifiers also stack (eg. ''w.3'' produces a 16-tick-long note length, equivalent to ''h'').

	Notes and Rests:		Notes and Rests:
	* X - Rest
	* CDEFGAB - Piano notes, can be followed by:		* ''X'' - Rest
	** # - Sharp		* ''CDEFGAB'' - Piano notes, can be followed by:
	** ! - Flat		** ''#'' - Sharp
			** ''!'' - Flat

			Drums are hardcoded percussion effects, created by rapidly changing the frequency emitted by the PC Speaker. They last for approximately 14 milliseconds each, with the exception of the 1-millisecond tick.

	{\| class="wikitable"		{\| class="wikitable"
Line 70:		Line 73:

	All other characters are silently ignored (like comments).		All other characters are silently ignored (like comments).

			== Quirks ==

			* The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow, causing ZZT to play a 256-tick-long note - which is also the maximum possible length of a single note.
			* Drums are timed using Turbo Pascal's built-in ''Delay()'' function. As it was designed for the late 1980s state of the art in computer technology, the frequencies will alternate far too quickly on more modern hardware.
			** The above also means that, on slower hardware, a drum playback actually stalls engine execution for the duration of its sound!

	== See Also ==		== See Also ==

RT-55J at 05:31, 12 February 2021

2021-02-12T05:31:46Z

← Older revision		Revision as of 05:31, 12 February 2021
Line 1:		Line 1:
	''[This article is a stub. You can help by filling it out.]''		''[This article is a stub. You can help by filling it out.]''

	The '''#play''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects.		The '''#play [sound]''' command in [[ZZT-OOP]] allows [[object\|objects]] and [[scroll\|scrolls]] to play music and sound effects. (Note a scroll using '''#play''' does not suppress the default scroll sound effect.)

	~~The general syntax is that parameters come before the notes and drums they modify.~~		== Sound Format ==

	The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).		The general syntax is that parameters come before the notes and drums they modify. The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).

	{\| class="wikitable"		{\| class="wikitable"
Line 32:		Line 32:
	\| - \|\| Down octave \|\| N/A		\| - \|\| Down octave \|\| N/A
	\|}		\|}

			In order to work, the triplet and time-and-a-half modifiers need to be placed somewhere after the length parameters they are modifying (eg ''w3'' or ''h.''). Also, these parameters can stack on each other (eg w3. produces a 15-tick-long note length).

			The triplet and time-and-a-half parameters use integer floor division. If the result of the division is 0 (with either ''t3'' or ''s3''), then the length value will underflow and ZZT will play a 256-tick-long notes (~25 seconds each).

	Notes and Rests:		Notes and Rests:
Line 65:		Line 69:
	\|}		\|}

	All other ~~character~~ are silently ignored (like comments).		All other characters are silently ignored (like comments).

	== See Also ==		== See Also ==

RT-55J: basic summary

2021-02-12T03:41:49Z

basic summary

New page

''[This article is a stub. You can help by filling it out.]''

The '''#play''' command in [[ZZT-OOP]] allows [[object|objects]] and [[scroll|scrolls]] to play music and sound effects.

The general syntax is that parameters come before the notes and drums they modify.

The octave and length parameters are reset each line. The default note length is 1 (32nd note), and the default octave is 3 (ranges from 1 to 6 inclusively).

{| class="wikitable"
|+ Parameters
|-
! Symbol !! Denotes !! Length in Ticks
|-
| t || 32nd Note || 1
|-
| s || Sixteenth Note || 2
|-
| i || Eighth Note || 4
|-
| q || Quarter Note || 8
|-
| h || Half Note || 16
|-
| w || Whole Note || 32
|-
| 3 || Triplet || (n/3)
|-
| . || Time-and-a-half || (n*3)/2
|-
| + || Up octave || N/A
|-
| - || Down octave || N/A
|}

Notes and Rests:
* X - Rest
* CDEFGAB - Piano notes, can be followed by:
** # - Sharp
** ! - Flat

{| class="wikitable"
|+ Drums
|-
! Symbol !! "Sound"
|-
| 0 || Tick
|-
| 1 || Tweet
|-
| 2 || Cowbell
|-
| 3 || ''N/A -- Denotes Triplet''
|-
| 4 || Hi snare
|-
| 5 || Hi woodblock
|-
| 6 || Low snare
|-
| 7 || Low tom
|-
| 8 || Low woodblock
|-
| 9 || Bass drum
|}

All other character are silently ignored (like comments).

== See Also ==

* [[Sound effects]] - ZZT's built-in sound effects, expressed in #play statements.
* [[Play/Duration_table|Duration Table]] - A programmatically generated list of possible note durations in ZZT-OOP

{{ZZT-OOP navbox}}