summaryrefslogtreecommitdiff
path: root/doc/classes/RID.xml
blob: 990e82593eca0e636483d4dc30bf23dad3e973c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RID" version="4.0">
	<brief_description>
		Handle for a [Resource]'s unique ID.
	</brief_description>
	<description>
		The RID type is used to access the unique integer ID of a resource. They are opaque, which means they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [RenderingServer].
	</description>
	<tutorials>
	</tutorials>
	<constructors>
		<constructor name="RID">
			<return type="RID" />
			<description>
				Constructs an empty [RID] with the invalid ID [code]0[/code].
			</description>
		</constructor>
		<constructor name="RID">
			<return type="RID" />
			<argument index="0" name="from" type="RID" />
			<description>
				Constructs a [RID] as a copy of the given [RID].
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="get_id" qualifiers="const">
			<return type="int" />
			<description>
				Returns the ID of the referenced resource.
			</description>
		</method>
		<method name="is_valid" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if [RID] is valid.
			</description>
		</method>
	</methods>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<description>
			</description>
		</operator>
		<operator name="operator !=">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
		<operator name="operator &lt;">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
		<operator name="operator &lt;=">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
		<operator name="operator &gt;">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
		<operator name="operator &gt;=">
			<return type="bool" />
			<argument index="0" name="right" type="RID" />
			<description>
			</description>
		</operator>
	</operators>
</class>