| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | <?xml version="1.0" encoding="UTF-8" ?> | 
					
						
							| 
									
										
										
										
											2017-11-15 18:37:54 +01:00
										 |  |  | <class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-alpha"> | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 	<brief_description> | 
					
						
							|  |  |  | 		Input event type for mouse button events. | 
					
						
							|  |  |  | 	</brief_description> | 
					
						
							|  |  |  | 	<description> | 
					
						
							| 
									
										
										
										
											2017-10-16 00:07:13 +02:00
										 |  |  | 		Contains mouse click informations. See [method Node._input]. | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 	</description> | 
					
						
							|  |  |  | 	<tutorials> | 
					
						
							| 
									
										
										
										
											2017-10-16 00:07:13 +02:00
										 |  |  | 		http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 	</tutorials> | 
					
						
							|  |  |  | 	<demos> | 
					
						
							|  |  |  | 	</demos> | 
					
						
							|  |  |  | 	<methods> | 
					
						
							|  |  |  | 		<method name="get_button_index" qualifiers="const"> | 
					
						
							|  |  |  | 			<return type="int"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="get_factor"> | 
					
						
							|  |  |  | 			<return type="float"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="is_doubleclick" qualifiers="const"> | 
					
						
							|  |  |  | 			<return type="bool"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="set_button_index"> | 
					
						
							|  |  |  | 			<return type="void"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<argument index="0" name="button_index" type="int"> | 
					
						
							|  |  |  | 			</argument> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="set_doubleclick"> | 
					
						
							|  |  |  | 			<return type="void"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<argument index="0" name="doubleclick" type="bool"> | 
					
						
							|  |  |  | 			</argument> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="set_factor"> | 
					
						
							|  |  |  | 			<return type="void"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<argument index="0" name="factor" type="float"> | 
					
						
							|  |  |  | 			</argument> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 		<method name="set_pressed"> | 
					
						
							|  |  |  | 			<return type="void"> | 
					
						
							|  |  |  | 			</return> | 
					
						
							|  |  |  | 			<argument index="0" name="pressed" type="bool"> | 
					
						
							|  |  |  | 			</argument> | 
					
						
							|  |  |  | 			<description> | 
					
						
							|  |  |  | 			</description> | 
					
						
							|  |  |  | 		</method> | 
					
						
							|  |  |  | 	</methods> | 
					
						
							|  |  |  | 	<members> | 
					
						
							| 
									
										
										
										
											2017-09-13 08:49:40 +02:00
										 |  |  | 		<member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> | 
					
						
							| 
									
										
										
										
											2017-11-15 18:45:34 +01:00
										 |  |  | 			Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope]. | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 		</member> | 
					
						
							| 
									
										
										
										
											2017-09-13 08:49:40 +02:00
										 |  |  | 		<member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick"> | 
					
						
							| 
									
										
										
										
											2017-10-16 00:07:13 +02:00
										 |  |  | 			If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 		</member> | 
					
						
							| 
									
										
										
										
											2017-09-13 08:49:40 +02:00
										 |  |  | 		<member name="factor" type="float" setter="set_factor" getter="get_factor"> | 
					
						
							| 
									
										
										
										
											2017-10-16 00:07:13 +02:00
										 |  |  | 			TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 		</member> | 
					
						
							| 
									
										
										
										
											2017-09-13 08:49:40 +02:00
										 |  |  | 		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> | 
					
						
							| 
									
										
										
										
											2017-10-16 00:07:13 +02:00
										 |  |  | 			If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released. | 
					
						
							| 
									
										
										
										
											2017-09-12 17:42:36 -03:00
										 |  |  | 		</member> | 
					
						
							|  |  |  | 	</members> | 
					
						
							|  |  |  | 	<constants> | 
					
						
							|  |  |  | 	</constants> | 
					
						
							|  |  |  | </class> |