Audiograph - Revision history

Dragofer at 10:25, 13 November 2022

2022-11-13T10:25:50Z

← Older revision		Revision as of 10:25, 13 November 2022
Line 72:		Line 72:
	The following script functions are suitable for use by external scripts:		The following script functions are suitable for use by external scripts:
	load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings" or the audiograph is already loaded.		load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings" or the audiograph is already loaded.
	return_spindle() //the currently loaded spindle will be given to the player		return_spindle( float return_to_inv ) //the currently loaded spindle will be unloaded and either given to the player or reappear where it was picked up, depending on the value of return_to_inv.

	Example script to cause an audiograph to start playing a sound if it's loaded with a spindle and isn't already playing it:		Example script to cause an audiograph to start playing a sound if it's loaded with a spindle and isn't already playing it:

Dragofer at 10:01, 13 November 2022

2022-11-13T10:01:04Z

← Older revision		Revision as of 10:01, 13 November 2022
Line 72:		Line 72:
	The following script functions are suitable for use by external scripts:		The following script functions are suitable for use by external scripts:
	load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings" or the audiograph is already loaded.		load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings" or the audiograph is already loaded.
	~~toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it~~
	return_spindle() //the currently loaded spindle will be given to the player		return_spindle() //the currently loaded spindle will be given to the player

Line 82:		Line 81:
	if( aud.is_loaded && !aud.is_playing )		if( aud.is_loaded && !aud.is_playing )
	{		{
	~~aud~~.~~toggle_audiograph~~();		sys.trigger(aud);
	}		}
	}		}

	[[Category:Editing]]		[[Category:Editing]]

Dragofer at 09:59, 13 November 2022

2022-11-13T09:59:45Z

← Older revision		Revision as of 09:59, 13 November 2022
Line 71:		Line 71:

	The following script functions are suitable for use by external scripts:		The following script functions are suitable for use by external scripts:
	load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings".		load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings" or the audiograph is already loaded.
	toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it		toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it
	return_spindle() //the currently loaded spindle will be given to the player		return_spindle() //the currently loaded spindle will be given to the player

Dragofer at 09:57, 13 November 2022

2022-11-13T09:57:07Z

← Older revision		Revision as of 09:57, 13 November 2022
Line 47:		Line 47:
	===Triggering targets at the end of a recording===		===Triggering targets at the end of a recording===

	~~The~~ targets of the spindle will be triggered if an audiograph finishes playing it, if the spindle is not set to loop (spawnarg "loop" "0").		By default the targets of the spindle will be triggered if an audiograph finishes playing it, as long as the spindle is not set to loop (spawnarg "loop" "0"). The following spawnargs for the spindle offer more control over this behaviour:
			* trigger_max: Maximum number of times this spindle is allowed to trigger its targets after the recording finishes playing.
			* trigger_from: Only trigger the spindle's targets if the spindle is played from the audiograph specified in this spawnarg. More audiographs can be specified in additional spawnargs i.e. trigger_from2.


Line 66:		Line 68:
	float is_playing //whether the audiograph is playing the spindle, 0 or 1		float is_playing //whether the audiograph is playing the spindle, 0 or 1
	entity spindle //the currently loaded spindle entity		entity spindle //the currently loaded spindle entity
			Furthermore, the number of times a spindle has triggered its targets is stored as a "trigger_num" spawnarg on the spindle itself.

	The following script functions are suitable for use by external scripts:		The following script functions are suitable for use by external scripts:
	load_spindle() //if the ~~player has a spindle selected~~ in ~~his~~ inventory~~, it will be loaded into the audiograph~~		load_spindle( entity e ) //attempts to load the specified entity into the audiograph. Will do nothing if the entity is not in the inventory category "Recordings".
	toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it		toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it
	return_spindle() //the currently loaded spindle will be given to the player		return_spindle() //the currently loaded spindle will be given to the player

Dragofer at 09:07, 12 November 2022

2022-11-12T09:07:24Z

← Older revision		Revision as of 09:07, 12 November 2022
Line 43:		Line 43:
	* snd_load (audiograph): sound made when loading a spindle onto the audiograph.		* snd_load (audiograph): sound made when loading a spindle onto the audiograph.
	* snd_unload (audiograph): sound made when unloading a spindle from the audiograph. Note that this will play simultaneously with "snd_acquire" on the spindle.		* snd_unload (audiograph): sound made when unloading a spindle from the audiograph. Note that this will play simultaneously with "snd_acquire" on the spindle.


	===Triggering targets at the end of a recording===		===Triggering targets at the end of a recording===

Dragofer at 09:07, 12 November 2022

2022-11-12T09:07:13Z

← Older revision		Revision as of 09:07, 12 November 2022
Line 33:		Line 33:
	A spindle is unloaded by frobbing the spindle that's attached to the audiograph.		A spindle is unloaded by frobbing the spindle that's attached to the audiograph.


			===Sounds===

			The following spawnargs are available for setting sounds, on the spindle and audiograph respectively:
			* snd_audiograph (spindle): the main sound you want the recording to play.
			* snd_noise (spindle): an additional layer of background noise to be played together with the recording. It can be disabled by setting to "silence" or "nosound".
			* snd_switch_on (audiograph): sound made when starting a recording. The recording will start after this sound finishes.
			* snd_switch_off (audiograph): sound made when a recording ends.
			* snd_load (audiograph): sound made when loading a spindle onto the audiograph.
			* snd_unload (audiograph): sound made when unloading a spindle from the audiograph. Note that this will play simultaneously with "snd_acquire" on the spindle.

	===Triggering targets at the end of a recording===		===Triggering targets at the end of a recording===

Dragofer at 11:53, 11 November 2022

2022-11-11T11:53:39Z

← Older revision		Revision as of 11:53, 11 November 2022
Line 52:		Line 52:

	The following variables are available:		The following variables are available:
	is_loaded //whether a spindle is loaded into this audiograph, 0 or 1		float is_loaded //whether a spindle is loaded into this audiograph, 0 or 1
	is_playing //whether the audiograph is playing the spindle, 0 or 1		float is_playing //whether the audiograph is playing the spindle, 0 or 1
	spindle //the currently loaded spindle entity		entity spindle //the currently loaded spindle entity

	The following script functions are suitable for use by external scripts:		The following script functions are suitable for use by external scripts:

Dragofer at 10:27, 11 November 2022

2022-11-11T10:27:08Z

← Older revision		Revision as of 10:27, 11 November 2022
Line 3:		Line 3:
	<span style="color: red">This article documents the audiograph, which will be available from 2.11 onwards. You can download it from here if you want to use it before 2.11 is released: https://forums.thedarkmod.com/index.php?/topic/20475-dragofers-scripting/</span>		<span style="color: red">This article documents the audiograph, which will be available from 2.11 onwards. You can download it from here if you want to use it before 2.11 is released: https://forums.thedarkmod.com/index.php?/topic/20475-dragofers-scripting/</span>

	~~The audiograph is an Inventor's Guild device for playing back recordings stored on spindles. It offers the following features:~~

	* Every audiograph ~~can load and unload any spindle~~, a metal ~~cylinder~~ the player can ~~carry~~ in his inventory.		The audiograph is an Inventor's Guild device for playing back recordings stored on spindles, which are small metal cylinders the player can pick up and store in his inventory. It offers the following features:

			* Every audiograph can load, unload and play any spindle.
	* Spindles are loaded by frobbing or using an audiograph while the player has a spindle selected in his inventory.		* Spindles are loaded by frobbing or using an audiograph while the player has a spindle selected in his inventory.
	* To start or stop playing the recording, frob the audiograph or trigger it from i.e. a lever.		* To start or stop playing the recording, frob the audiograph or trigger it from i.e. a lever.
	* Audiographs can target a spindle to automatically load it at map start. If the "start_on" spawnarg is set it will play the recording.		* Audiographs can target a spindle to automatically load it at map start. If the "start_on" spawnarg is set it will play the recording.
	* AIs can be alerted if an audiograph plays certain recordings.		* AIs can be alerted if an audiograph plays (certain) recordings.
	* The spindle's targets can be triggered at the end of a recording (non-looping sounds only).		* The spindle's targets can be triggered at the end of a recording (non-looping sounds only).

Dragofer at 10:22, 11 November 2022

2022-11-11T10:22:34Z

← Older revision		Revision as of 10:22, 11 November 2022
Line 64:		Line 64:
	{		{
	audiograph aud = $atdm_audiograph_1;		audiograph aud = $atdm_audiograph_1;

	if( aud.is_loaded && !aud.is_playing )		if( aud.is_loaded && !aud.is_playing )
	{		{

Dragofer at 10:22, 11 November 2022

2022-11-11T10:22:22Z

@@ Line 59: / Line 59: @@
   toggle_audiograph() //if a spindle is loaded, the audiograph will either start or stop playing it
   return_spindle() //the currently loaded spindle will be given to the player
 [[Category:Editing]]