<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="funnel" module="max" category="Data, Lists">
	<digest>
		Tag data with its inlet number
	</digest>
	<description>
		Identifies the inlet of incoming data. It can be used to store values into a <o>table</o> or <o>coll</o> based on their source, or used to set a destination with an object such as <o>spray</o>.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			Data
		</metadata>
		<metadata name="tag">
			Lists
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				int, float or list, Will Be Output Preceded by 0
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
				int, float or list, Will Be Output Preceded by 1
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				list, Labelled With Source Inlet Number
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="inlets" optional="1" type="int">
			<digest>
				Number of inlets
			</digest>
			<description>
				The first argument sets the number of inlets in the <o>funnel</o>. If there is no argument there will be two inlets.
			</description>
		</objarg>
		<objarg name="offset" optional="1" type="int">
			<digest>
				Number of inlets
			</digest>
			<description>
				The second argument specifies an offset for the first inlet number. If no second argument is present, the inlets are numbered beginning with 0.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Send most recent data
			</digest>
			<description>
				In any inlet: The number of the inlet and the stored (most recently received) number in that inlet are sent out as a two-item list.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="input" optional="0" type="int" />
			</arglist>
			<digest>
				Output tagged data
			</digest>
			<description>
				In any inlet: The number of the inlet and the received number are sent out as a list.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="input" optional="0" type="float" />
			</arglist>
			<digest>
				Output tagged data
			</digest>
			<description>
				In any inlet: The number of the inlet and the received number are sent out as a list.
			</description>
		</method>
		<method name="list">
			<arglist>
				<arg name="inputs" optional="0" type="list" />
			</arglist>
			<digest>
				Output tagged data
			</digest>
			<description>
				In any inlet: The number of the inlet is prepended to the list, and the new list is sent out. In a list floats are not converted to ints. The list may contain ints, floats, and symbols (provided that the first element of the list is not a symbol).
			</description>
		</method>
		<method name="anything">
			<arglist>
				<arg name="inputs" optional="0" type="list" />
			</arglist>
			<digest>
				Output tagged data
			</digest>
			<description>
				Functions the same as <m>list</m>.
			</description>
		</method>
		<method name="offset">
			<arglist>
				<arg name="offset" optional="0" type="int" />
			</arglist>
			<digest>
				Offset the tag value
			</digest>
			<description>
				The word <m>offset</m> followed by a number will offset the numbering of inlets by the number given.
			</description>
		</method>
		<method name="set">
			<arglist>
				<arg name="inputs" optional="0" type="list" />
			</arglist>
			<digest>
				Store the data with no output
			</digest>
			<description>
				In any inlet: The word <m>set</m> followed by a list of numbers which correspond with the number of inlets, will set the input list of numbers without sending them through the outputs.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="funnel.png" caption="Use funnel to tag incoming data, or to store data into a coll object" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="listfunnel" />
		<seealso name="spray" />
	</seealsolist>
	<misc name="Output">
		<entry name="list">
			<description>
				When a number or list is received in any inlet, <o>funnel</o> outputs a list consisting of the inlet number followed the input. <o>funnel</o> can be useful in conjunction with other objects such as <o>coll</o>, <o>funbuff</o> and <o>table</o>.
			</description>
		</entry>
	</misc>
</c74object>
