<?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="number~" module="msp" category="MSP U/I">
	<digest>
		Signal monitor and constant generator
	</digest>
	<description>
		Use the <o>number~</o> object to display signal values or generate them.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP U/I
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				Input to Display
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="double">
			<digest>
				Ramp time in Milliseconds
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				Number Value as a Signal
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="double">
			<digest>
				Signal Value
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<palette category="Audio" action="number~" pic="number~.svg" />
	<!--ARGUMENTS-->
	<objarglist>
		<objarg id="0" name="OBJARG_NAME" type="OBJARG_TYPE" optional="0">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Output the current signal value
			</digest>
			<description>
				In signal output mode, a <m>bang</m> message will output the current signal value.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="input" optional="0" type="int" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				Converted to <m>float</m>.				<br />
				In left inlet: The value is sent out the left outlet as a constant signal. When <o>number~</o> is in Signal Output display mode, the value is displayed. If the current ramp time is non-zero, the output signal will ramp between its previous value and the newly set value.
				<br />
				In right inlet: Sets a ramp time in milliseconds. The default time is 0.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="input" optional="0" type="float" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: The value is sent out the left outlet as a constant signal. When <o>number~</o> is in Signal Output display mode, the value is displayed. If the current ramp time is non-zero, the output signal will ramp between its previous value and the newly set value.
				<br />
				In right inlet: Sets a ramp time in milliseconds. The default time is 0.
			</description>
		</method>
		<method name="list">
			<arglist>
				<arg name="input-value" optional="0" type="number" />
				<arg name="ramp-time" optional="0" units="ms" type="int" />
			</arglist>
			<digest>
				Set a signal value and ramp time
			</digest>
			<description>
				The first number sets the value of the signal sent out the left outlet, and the second number sets the ramp time in milliseconds.
			</description>
		</method>
		<method name="allow">
			<arglist>
				<arg name="display-mode-availability" optional="0" type="int" />
			</arglist>
			<digest>
				Specicy allowable display modes
			</digest>
			<description>
				The word <m>allow</m>, followed by a number, sets what display modes can be used. <m>allow 1</m> restricts <o>number~</o> to signal output display mode. <m>allow 2</m> restricts <o>number~</o> to input monitor display mode. <m>allow 3</m> allows both modes, and lets the user switch between them by clicking on the left triangular area of <o>number~</o>.
			</description>
		</method>
		<method name="flags">
			<arglist>
				<arg name="appearance/behavior" optional="0" type="int" />
			</arglist>
			<digest>
				Legacy support
			</digest>
			<description>
				The <m>flags</m> message is provided for legacy support of the <o>number~</o> object; all the original functionality is now provided by object attributes.
			</description>
		</method>
		<method name="ft1">
			<arglist>
				<arg name="input" optional="0" type="float" />
			</arglist>
			<digest>
				Set the ramp time
			</digest>
			<description>
				In right inlet: Sets a ramp time in milliseconds. The default time is 0.
			</description>
		</method>
		<method name="max">
			<arglist>
				<arg name="maximum-value" optional="0" type="number" />
			</arglist>
			<digest>
				Set the maximum output value
			</digest>
			<description>
				The word <m>max</m>, followed by an optional number, sets the maximum value of <o>number~</o> for signal output. Note that unlike a floating-point number box, the maximum value of <o>number~</o> is not restricted to being an integer value. If the word <m>max</m> is not followed by a number, any maximum value is removed.
			</description>
		</method>
		<method name="min">
			<arglist>
				<arg name="minimum-value" optional="0" type="number" />
			</arglist>
			<digest>
				Set the maximum output value
			</digest>
			<description>
				The word <m>min</m>, followed by an optional number, sets the minimum value of <o>number~</o> for signal output. Note that unlike a floating-point number box, the minimum value of <o>number~</o> is not restricted to being an integer value. If the word <m>min</m> is not followed by a number, any minimum value is removed.
			</description>
		</method>
		<method name="mode">
			<arglist>
				<arg name="display-mode" optional="0" type="int" />
			</arglist>
			<digest>
				Set the current display mode
			</digest>
			<description>
				The word <m>mode</m>, followed by a number, sets the current display mode, if it is currently allowed (see the <m>allow</m> message). <m>mode 1</m> sets signal output display mode. <m>mode 2</m> sets signal input monitor display mode.
			</description>
		</method>
		<method name="(mouse)">
			<digest>
				Click to choose monitor/output display modes
			</digest>
			<description>
				Clicking on the triangular area at the left side of <o>number~</o> will toggle between Signal Monitor display mode (green waveform) and Signal Output display mode (yellow or green downward arrow). When in Signal Output display mode, clicking in the area that displays the number changes the value of the signal sent out the left outlet of <o>number~</o> and/or selects it for typing.
			</description>
		</method>
		<method name="set">
			<arglist>
				<arg name="set-input" optional="0" type="float" />
			</arglist>
			<digest>
				Display a number without causing output
			</digest>
			<description>
				The word <m>set</m> followed by a number sets the <o>number~</o> object to display that number without causing output.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Signal input to be sampled and output
			</digest>
			<description>
				Any signal, the value of which is sampled and sent out the right outlet at regular intervals. When <o>number~</o> is in Signal Monitor display mode, the signal value is displayed.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="bgcolor" get="1" set="1" type="float" size="4">
			<digest>
				Displayed/unclicked background color
			</digest>
			<description>
				Sets the color for the <o>number~</o> box object's displayed/unclicked background.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Color" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Background Color" />
				<attribute name="legacydefault" get="1" set="1" type="float" size="4" value="0.97 0.97 0.97 1." />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="preview" get="1" set="1" type="symbol" size="1" value="rect_fill" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="set" get="1" set="1" type="pointer" size="1" value="pointer" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
			</attributelist>
		</attribute>
		<attribute name="bgcolor2" get="1" set="1" type="atom" size="1">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
			<attributelist>
				<attribute name="invisible" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="obsolete" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="bordercolor" get="1" set="1" type="atom" size="1">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
			<attributelist>
				<attribute name="invisible" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="obsolete" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="ft1" get="1" set="1" type="float" size="1">
			<digest>
				Interpolation ramp time
			</digest>
			<description>
				The word <m>ft1</m>, followed by a number, sets the interpolation ramp time in milliseconds. The default time is 0.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Value" />
				<attribute name="default" get="1" set="1" type="float" size="1" value="0." />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Ramp Time in Milliseconds" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="hbgcolor" get="1" set="1" type="atom" size="1">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
			<attributelist>
				<attribute name="invisible" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="obsolete" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="htextcolor" get="1" set="1" type="atom" size="1">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
			<attributelist>
				<attribute name="invisible" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="obsolete" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="interval" get="1" set="1" type="float" size="1">
			<digest>
				Display update interval
			</digest>
			<description>
				Sets the update interval, in milliseconds. This controls the rate at which the display is updated when <o>number~</o> is input monitor display mode, as well as the rate that numbers are sent out the object's right outlet.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Value" />
				<attribute name="default" get="1" set="1" type="float" size="1" value="100." />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Update Interval in Milliseconds" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="maximum" get="1" set="1" type="atom" size="1">
			<digest>
				Maximum display/output value
			</digest>
			<description>
				Sets the maximum value that can be displayed or sent out by the object.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Value" />
				<attribute name="default" get="1" set="1" type="atom" size="1" value="&lt;none&gt;" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Maximum" />
				<attribute name="order" get="1" set="1" type="int" size="1" value="2" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="minimum" get="1" set="1" type="atom" size="1">
			<digest>
				Minimum display/output value
			</digest>
			<description>
				Sets the minimum value that can be displayed or sent out by the object.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Value" />
				<attribute name="default" get="1" set="1" type="atom" size="1" value="&lt;none&gt;" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Minimum" />
				<attribute name="order" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="monitormode" get="1" set="1" type="int" size="1">
			<digest>
				Signal monitor mode toggle
			</digest>
			<description>
				Toggles the signal monitor mode. The default is 1 (on).
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Mode" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Permit Signal Monitor Mode" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="numdecimalplaces" get="1" set="1" type="int" size="1">
			<digest>
				Number of Decimal Places
			</digest>
			<description>
				Number of decimal places displayed
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Appearance" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="0" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Number of Decimal Places" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="sigoutmode" get="1" set="1" type="int" size="1">
			<digest>
				Signal output mode toggle
			</digest>
			<description>
				Toggles the signal output mode. The default is 1 (on).
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Mode" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Permit Signal Output Mode" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="style" get="1" set="1" type="symbol" size="1">
			<digest>
				Style
			</digest>
			<description>
				Sets the <link type="vignette" module="core" name="styles">style</link> to be applied to the object. Styles can be set using the <link type="vignette" module="core" name="format_palette">Format palette</link>.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Appearance" />
				<attribute name="introduced" get="1" set="1" type="symbol" size="1" value="7.0.0" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Style" />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="style" />
			</attributelist>
		</attribute>
		<attribute name="textcolor" get="1" set="1" type="float" size="4">
			<digest>
				Number value text color
			</digest>
			<description>
				Sets the color for the <o>number~</o> box object's displayed/unclicked number values. The <m>textcolor</m> attribute is mapped to the <m>textcolor_inverse</m>  <link module="core" name="maxcolor" type="vignette">style color</link>.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="atom" size="1" value="Color" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Text Color" />
				<attribute name="legacydefault" get="1" set="1" type="float" size="4" value="0. 0. 0. 1." />
				<attribute name="paint" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="set" get="1" set="1" type="pointer" size="1" value="pointer" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
				<attribute name="stylemap" get="1" set="1" type="symbol" size="1" value="textcolor_inverse" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="number~.png" caption="Several uses for the number~ object" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="line~" />
		<seealso name="sig~" />
		<seealso name="snapshot~" />
		<seealso name="14_analysischapter01" module="msp" type="tutorial" />
	</seealsolist>
	<discussion>
		The <o>number~</o> object has two different display modes. In Signal Monitor Mode it displays the value of the <m>signal</m> received in the left inlet.
		<br />
		<br />
		In Signal Output Mode it displays the value of the <m>float</m> or <m>int</m> most recently received in the left inlet, or entered directly into the <o>number~</o> box (the signal being sent out the left outlet). When a <o>number~</o> object is highlighted (indicated by a yellow downward arrow), numerical keyboard input changes its value. Clicking the mouse or pressing Return or Enter stores a pending typed number and sends it out the left outlet as the new signal value.
	</discussion>
	<misc name="Output">
		<entry name="signal">
			<description>
				Out left outlet: When audio is on, <o>number~</o> sends a constant signal out its left outlet equal to the number most recently received in the left inlet (or entered by the user). It sends out this value independent of its <m>signal</m> input, and whether or not it is currently in Signal Output display mode. If the ramp time most recently received in the right inlet is set to a non-zero value, the output will interpolate between its previous value and a newly set value over the specified time.
			</description>
		</entry>
		<entry name="float">
			<description>
				Out right outlet: Samples of the input signal are sent out at a rate specified by the <m>interval</m> message.
			</description>
		</entry>
	</misc>
</c74object>
