virtualx-engine/doc/classes/ButtonGroup.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ButtonGroup" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Group of Buttons.
	</brief_description>
	<description>
		Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
		[member BaseButton.toggle_mode] should be [code]true[/code].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_buttons">
			<return type="Array" />
			<description>
				Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.group]).
			</description>
		</method>
		<method name="get_pressed_button">
			<return type="BaseButton" />
			<description>
				Returns the current pressed button.
			</description>
		</method>
	</methods>
	<members>
		<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />
	</members>
	<signals>
		<signal name="pressed">
			<argument index="0" name="button" type="Object" />
			<description>
				Emitted when one of the buttons of the group is pressed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-03-16 23:01:02 +01:00			`<class name="ButtonGroup" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Group of Buttons.`
			`</brief_description>`
			`<description>`
			`Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.`
Mention about BaseButton.toggle_mode in ButtonGroup description 2018-02-21 07:53:30 +01:00			`[member BaseButton.toggle_mode] should be [code]true[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
Expose ButtonGroup's "get_buttons()" to GDScript 2018-12-14 06:39:31 +01:00			`<method name="get_buttons">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="Array" />`
Expose ButtonGroup's "get_buttons()" to GDScript 2018-12-14 06:39:31 +01:00			`<description>`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.group]).`
Expose ButtonGroup's "get_buttons()" to GDScript 2018-12-14 06:39:31 +01:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<method name="get_pressed_button">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="BaseButton" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
Expose ButtonGroup's "get_buttons()" to GDScript 2018-12-14 06:39:31 +01:00			`Returns the current pressed button.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</method>`
			`</methods>`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`<members>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-02 21:15:17 +01:00			`<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`</members>`
Adds a pressed signal to ButtonGroup (cherry picked from commit 323f1769157cd9e30c504fa6f54e8ba0889cfac3) 2021-05-06 12:16:27 +02:00			`<signals>`
			`<signal name="pressed">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<argument index="0" name="button" type="Object" />`
Adds a pressed signal to ButtonGroup (cherry picked from commit 323f1769157cd9e30c504fa6f54e8ba0889cfac3) 2021-05-06 12:16:27 +02:00			`<description>`
			`Emitted when one of the buttons of the group is pressed.`
			`</description>`
			`</signal>`
			`</signals>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<constants>`
			`</constants>`
			`</class>`