virtualx-engine/modules/openxr/doc_classes/OpenXRIPBinding.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OpenXRIPBinding" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Defines a binding between an [OpenXRAction] and an XR input or output.
	</brief_description>
	<description>
		This binding resource binds an [OpenXRAction] to inputs or outputs. As most controllers have left hand and right versions that are handled by the same interaction profile we can specify multiple bindings. For instance an action "Fire" could be bound to both "/user/hand/left/input/trigger" and "/user/hand/right/input/trigger".
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_path">
			<return type="void" />
			<param index="0" name="path" type="String" />
			<description>
				Add an input/output path to this binding.
			</description>
		</method>
		<method name="get_path_count" qualifiers="const">
			<return type="int" />
			<description>
				Get the number of input/output paths in this binding.
			</description>
		</method>
		<method name="has_path" qualifiers="const">
			<return type="bool" />
			<param index="0" name="path" type="String" />
			<description>
				Returns [code]true[/code] if this input/output path is part of this binding.
			</description>
		</method>
		<method name="remove_path">
			<return type="void" />
			<param index="0" name="path" type="String" />
			<description>
				Removes this input/output path from this binding.
			</description>
		</method>
	</methods>
	<members>
		<member name="action" type="OpenXRAction" setter="set_action" getter="get_action">
			[OpenXRAction] that is bound to these paths.
		</member>
		<member name="paths" type="PackedStringArray" setter="set_paths" getter="get_paths" default="PackedStringArray()">
			Paths that define the inputs or outputs bound on the device.
		</member>
	</members>
</class>