<?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="cycle" module="max" category="Data">
	<digest>
		Round-robin messages to outlets
	</digest>
	<description>
		Each incoming number is sent to the next outlet, wrapping around to the first outlet after the last has been reached.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			Data
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				Number to Send to Successive Outlets
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Output of Item 1
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="outlets" optional="1" type="int">
			<digest>
				Number of outlets
			</digest>
			<description>
				Determines the number of outlets. If there is no argument, there will be one outlet.
			</description>
		</objarg>
		<objarg name="mode" optional="1" type="int">
			<digest>
				Output mode
			</digest>
			<description>
				Sets the output mode. If it is non-zero, <o>cycle</o> detects separate &quot;events&quot; and restarts at the leftmost outlet when a new event occurs. Examples of separate events include messages with delays between them, and messages triggered by successive mouse clicks or MIDI events. A stream of items separated by commas in a message box is considered a single event. If this argument is not present or is <m>0</m>, the values cycle through all the outlets, regardless of whether they are attached to separate events or not.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Send a bang to the next output
			</digest>
			<description>
				Sends a bang to the next outlet.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="input" optional="0" type="int" />
			</arglist>
			<digest>
				Send value to the next outlet
			</digest>
			<description>
				The input to be directed to successive outlets.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="input" optional="0" type="float" />
			</arglist>
			<digest>
				Send value to the next outlet
			</digest>
			<description>
				The input to be directed to successive outlets.
			</description>
		</method>
		<method name="list">
			<arglist>
				<arg name="input" optional="0" type="list" />
			</arglist>
			<digest>
				Send value to the successive outlets
			</digest>
			<description>
				The stream of ints, floats, or symbols to be directed to successive outlets.
			</description>
		</method>
		<method name="anything">
			<arglist>
				<arg name="input" optional="0" type="list" />
			</arglist>
			<digest>
				Send value to the successive outlets
			</digest>
			<description>
				The stream of ints, floats, or symbols to be directed to successive outlets.
			</description>
		</method>
		<method name="thresh">
			<arglist>
				<arg name="mode" optional="0" type="int" />
			</arglist>
			<digest>
				Set output mode
			</digest>
			<description>
				The word <m>thresh</m>, followed by a number, sets the output mode, in the same way as the second typed-in argument. If the number is non-zero, <o>cycle</o> will detect separate &quot;events&quot; and restart at the leftmost outlet whenever a new event occurs. If the number is <m>0</m>, each number received will be directed to the next outlet in the cycle.
			</description>
		</method>
		<method name="set">
			<arglist>
				<arg name="outlet number" optional="0" type="int" />
			</arglist>
			<digest>
				Set next outlet
			</digest>
			<description>
				The word <m>set</m>, followed by a number, specifies an outlet to which the next input should be directed, if in cycle mode. Outlets are numbered beginning with 0; if an outlet number is specified that does not actually exist, the message is ignored. (This message has no effect when <o>cycle</o> is in event-sensitive mode, in which case each message is always sent out beginning at the leftmost outlet.)
			</description>
		</method>
		<method name="symbol">
			<arglist>
				<arg name="input" optional="0" type="symbol" />
			</arglist>
			<digest>
				The stream of ints, floats, or symbols to be directed to successive outlets.
			</digest>
			<description>
				The stream of ints, floats, or symbols to be directed to successive outlets.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="cycle.png" caption="Using cycle to get ASCII relief" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="bucket" />
		<seealso name="counter" />
		<seealso name="spell" />
		<seealso name="spray" />
	</seealsolist>
	<misc name="Output">
		<entry name="anything">
			<description>
				Out any outlet: In cycle mode, each successive int, float, or symbol received, either separately or as part of a list, is directed to an outlet to the right of the previous number. When the cycle reaches the rightmost outlet, the next number is sent out the left outlet.
				<br />
				<br />
				In event-sensitive mode, any int, float, or symbol which is a new event restarts the output at the left outlet.
			</description>
		</entry>
	</misc>
</c74object>
