File: CastleItems.TItemOnWorld.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (240 lines) | stat: -rw-r--r-- 15,296 bytes parent folder | download 
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleItems: Class TItemOnWorld</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TItemOnWorld"></a><h1 class="cio">Class TItemOnWorld</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td><a class="section" href="#PasDoc-Fields">Fields</a></td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleItems.html">CastleItems</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TItemOnWorld = class(<a class="normal" href="Castle3D.T3DOrient.html">T3DOrient</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Item that is placed on a 3D world, ready to be picked up. It's not in anyone's inventory.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TComponent</li>
<li class="ancestor"><a class="normal" href="Castle3D.T3D.html">T3D</a></li>
<li class="ancestor"><a class="normal" href="Castle3D.T3DList.html">T3DList</a></li>
<li class="ancestor"><a class="normal" href="Castle3D.T3DCustomTransform.html">T3DCustomTransform</a></li>
<li class="ancestor"><a class="normal" href="Castle3D.T3DOrient.html">T3DOrient</a></li>
<li class="thisitem">TItemOnWorld</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Fields"></a><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleItems.TItemOnWorld.html#RotationSpeed">RotationSpeed</a></b>: Single; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleItems.TItemOnWorld.html#AutoPick">AutoPick</a></b>: boolean; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>internal const <b><a  href="CastleItems.TItemOnWorld.html#DefaultRotationSpeed">DefaultRotationSpeed</a></b> = Pi;</code></td>
</tr>
</table>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleItems.TItemOnWorld.html#GetChild">GetChild</a></b>: <a  href="Castle3D.T3D.html">T3D</a>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleItems.TItemOnWorld.html#Create">Create</a></b>(AOwner: TComponent); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a  href="CastleItems.TItemOnWorld.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleItems.TItemOnWorld.html#GetExists">GetExists</a></b>: boolean; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleItems.TItemOnWorld.html#Render">Render</a></b>(const Frustum: <a  href="CastleFrustum.TFrustum.html">TFrustum</a>; const Params: <a  href="Castle3D.TRenderParams.html">TRenderParams</a>); override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleItems.TItemOnWorld.html#Update">Update</a></b>(const SecondsPassed: Single; var RemoveMe: <a  href="Castle3D.html#TRemoveType">TRemoveType</a>); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleItems.TItemOnWorld.html#ExtractItem">ExtractItem</a></b>: <a  href="CastleItems.TInventoryItem.html">TInventoryItem</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleItems.TItemOnWorld.html#Item">Item</a></b>: <a  href="CastleItems.TInventoryItem.html">TInventoryItem</a> read FItem;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleItems.TItemOnWorld.html#Collides">Collides</a></b> default false;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleItems.TItemOnWorld.html#CollidesWithMoving">CollidesWithMoving</a></b> default true;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="RotationSpeed"></a><code><b>RotationSpeed</b>: Single; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Speed of the rotation of 3D item on world. In radians per second, default is <a class="normal" href="CastleItems.TItemOnWorld.html#DefaultRotationSpeed">DefaultRotationSpeed</a>. Set to zero to disable rotation.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="AutoPick"></a><code><b>AutoPick</b>: boolean; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Does the player automatically picks up items by walking over them. Default is <code>True</code>. If you set this to <code>False</code>, you most probably want to implement some other way of picking up items, use the <a class="normal" href="CastleItems.TItemOnWorld.html#ExtractItem">ExtractItem</a> method.

<p>More precisely, this variable controls when <a class="normal" href="CastleItems.TInventoryItem.html#Picked">TInventoryItem.Picked</a> is called. When <code>True</code>, it is called for player when player steps over an item (otherwise it's never called). You can always override <a class="normal" href="CastleItems.TInventoryItem.html#Picked">TInventoryItem.Picked</a> for particular items to customize what happens at &quot;pick&quot; &mdash; the default implementation picks an item by adding it to inventory, but you could override it e.g. to consume some potions immediately on pickup.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DefaultRotationSpeed"></a><code>internal const <b>DefaultRotationSpeed</b> = Pi;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetChild"></a><code>function <b>GetChild</b>: <a  href="Castle3D.T3D.html">T3D</a>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="GetExists"></a><code>function <b>GetExists</b>: boolean; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Render"></a><code>procedure <b>Render</b>(const Frustum: <a  href="CastleFrustum.TFrustum.html">TFrustum</a>; const Params: <a  href="Castle3D.TRenderParams.html">TRenderParams</a>); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Render the item, on current Position with current rotation etc. Current matrix should be modelview, this pushes/pops matrix state (so it 1. needs one place on matrix stack, 2. doesn't modify current matrix).

<p>Pass current viewing Frustum to allow optimizing this (when item for sure is not within Frustum, we don't have to push it to OpenGL).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Update"></a><code>procedure <b>Update</b>(const SecondsPassed: Single; var RemoveMe: <a  href="Castle3D.html#TRemoveType">TRemoveType</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ExtractItem"></a><code>function <b>ExtractItem</b>: <a  href="CastleItems.TInventoryItem.html">TInventoryItem</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Extract the <a class="normal" href="CastleItems.TItemOnWorld.html#Item">Item</a>, used when picking up the <a class="normal" href="CastleItems.TInventoryItem.html">TInventoryItem</a> instance referenced by this <a class="normal" href="CastleItems.TItemOnWorld.html">TItemOnWorld</a> instance. This returns our <a class="normal" href="CastleItems.TItemOnWorld.html#Item">Item</a> property, and clears it (clearing also <a class="normal" href="CastleItems.TInventoryItem.html#Owner3D">TInventoryItem.Owner3D</a>). At the next <a class="normal" href="CastleItems.TItemOnWorld.html#Update">Update</a>, this <a class="normal" href="CastleItems.TItemOnWorld.html">TItemOnWorld</a> instance will be freed and removed from 3D world.

<p>It's up to you what to do with resulting <a class="normal" href="CastleItems.TInventoryItem.html">TInventoryItem</a> instance. You can pick it up, by <a class="normal" href="CastleItems.T3DAliveWithInventory.html#PickItem">T3DAliveWithInventory.PickItem</a> (for example player is an instance of <a class="normal" href="CastleItems.T3DAliveWithInventory.html">T3DAliveWithInventory</a>), or add it back to 3D world by <a class="normal" href="CastleItems.TInventoryItem.html#PutOnWorld">TInventoryItem.PutOnWorld</a>, or at least free it (or you'll get a memory leak).</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Item"></a><code>property <b>Item</b>: <a  href="CastleItems.TInventoryItem.html">TInventoryItem</a> read FItem;</code></td>
</tr>
<tr><td colspan="2">
<p>
The Item owned by this <a class="normal" href="CastleItems.TItemOnWorld.html">TItemOnWorld</a> instance. Never <code>Nil</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Collides"></a><code>property <b>Collides</b> default false;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CollidesWithMoving"></a><code>property <b>CollidesWithMoving</b> default true;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:10</em>
</span>
</td></tr></table></body></html>