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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<!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: CastleLevels: Class TLevelLogic</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="TLevelLogic"></a><h1 class="cio">Class TLevelLogic</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>Fields</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="CastleLevels.html">CastleLevels</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TLevelLogic = class(<a class="normal" href="Castle3D.T3D.html">T3D</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Level logic. We use <a class="normal" href="Castle3D.T3D.html">T3D</a> descendant, since this is the comfortable way to add any behavior to the 3D world (it doesn't matter that "level logic" is not a usual 3D object — it doesn't have to collide or be visible).</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="thisitem">TLevelLogic</li></ul><h2 class="overview">Overview</h2>
<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="CastleLevels.TLevelLogic.html#LoadLevelAnimation">LoadLevelAnimation</a></b>(const URL: string; const CreateFirstOctreeCollisions, CreateLastOctreeCollisions: boolean; const AnimationClass: <a href="CastleLevels.html#TCastlePrecalculatedAnimationClass">TCastlePrecalculatedAnimationClass</a>): <a href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a>;</code></td>
</tr>
<tr class="list2">
<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="CastleLevels.TLevelLogic.html#LoadLevelAnimation">LoadLevelAnimation</a></b>(const URL: string; const CreateFirstOctreeCollisions, CreateLastOctreeCollisions: boolean): <a href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a>;</code></td>
</tr>
<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="CastleLevels.TLevelLogic.html#LoadLevelScene">LoadLevelScene</a></b>(const URL: string; const CreateOctreeCollisions: boolean; const SceneClass: <a href="CastleLevels.html#TCastleSceneClass">TCastleSceneClass</a>): <a href="CastleScene.TCastleScene.html">TCastleScene</a>;</code></td>
</tr>
<tr class="list2">
<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="CastleLevels.TLevelLogic.html#LoadLevelScene">LoadLevelScene</a></b>(const URL: string; const CreateOctreeCollisions: boolean): <a href="CastleScene.TCastleScene.html">TCastleScene</a>;</code></td>
</tr>
<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="CastleLevels.TLevelLogic.html#Placeholder">Placeholder</a></b>(const Shape: <a href="CastleShapes.TShape.html">TShape</a>; const PlaceholderName: string): boolean; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleLevels.TLevelLogic.html#PlaceholdersEnd">PlaceholdersEnd</a></b>; virtual;</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>constructor <b><a href="CastleLevels.TLevelLogic.html#Create">Create</a></b>(AOwner: TComponent; AWorld: <a href="Castle3D.T3DWorld.html">T3DWorld</a>; MainScene: <a href="CastleScene.TCastleScene.html">TCastleScene</a>; DOMElement: TDOMElement); reintroduce; virtual;</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="CastleLevels.TLevelLogic.html#BoundingBox">BoundingBox</a></b>: <a href="CastleBoxes.TBox3D.html">TBox3D</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="CastleLevels.TLevelLogic.html#World">World</a></b>: <a href="Castle3D.T3DWorld.html">T3DWorld</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="CastleLevels.TLevelLogic.html#PrepareNewPlayer">PrepareNewPlayer</a></b>(NewPlayer: <a href="CastlePlayer.TPlayer.html">TPlayer</a>); virtual;</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="CastleLevels.TLevelLogic.html#Update">Update</a></b>(const SecondsPassed: Single; var RemoveMe: <a href="Castle3D.html#TRemoveType">TRemoveType</a>); override;</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="CastleLevels.TLevelLogic.html#Time">Time</a></b>: <a href="CastleTimeUtils.html#TFloatTime">TFloatTime</a> read FTime;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<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="LoadLevelAnimation"></a><code>function <b>LoadLevelAnimation</b>(const URL: string; const CreateFirstOctreeCollisions, CreateLastOctreeCollisions: boolean; const AnimationClass: <a href="CastleLevels.html#TCastlePrecalculatedAnimationClass">TCastlePrecalculatedAnimationClass</a>): <a href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Load 3D precalculated animation from (*.kanim) file, doing common tasks. </p>
<ul class="paragraph_spacing">
<li><p>optionally creates triangle octree for the FirstScene and/or LastScene</p></li>
<li><p>call <a class="normal" href="Castle3D.T3D.html#PrepareResources">PrepareResources</a>, with <a class="normal" href="CastleScene.html#prRender">prRender</a>, <a class="normal" href="CastleScene.html#prBoundingBox">prBoundingBox</a>, <a class="normal" href="CastleScene.html#prShadowVolume">prShadowVolume</a> (if shadow volumes possible at all in this OpenGL context)</p></li>
<li><p>Free texture data, since they will not be needed anymore</p></li>
<li><p>TimePlaying is by default <code>False</code>, so the animation is not playing.</p></li>
</ul>
<p> </p>
</td></tr>
</table>
<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="LoadLevelAnimation"></a><code>function <b>LoadLevelAnimation</b>(const URL: string; const CreateFirstOctreeCollisions, CreateLastOctreeCollisions: boolean): <a href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a>;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<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="LoadLevelScene"></a><code>function <b>LoadLevelScene</b>(const URL: string; const CreateOctreeCollisions: boolean; const SceneClass: <a href="CastleLevels.html#TCastleSceneClass">TCastleSceneClass</a>): <a href="CastleScene.TCastleScene.html">TCastleScene</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Load 3D scene from file, doing common tasks. </p>
<ul class="paragraph_spacing">
<li><p>optionally create triangle octree</p></li>
<li><p>call <a class="normal" href="Castle3D.T3D.html#PrepareResources">PrepareResources</a>, with <a class="normal" href="CastleScene.html#prRender">prRender</a>, <a class="normal" href="CastleScene.html#prBoundingBox">prBoundingBox</a>, <a class="normal" href="CastleScene.html#prShadowVolume">prShadowVolume</a> (if shadow volumes possible at all in this OpenGL context),</p></li>
<li><p>Free texture data, since they will not be needed anymore</p></li>
</ul>
<p> </p>
</td></tr>
</table>
<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="LoadLevelScene"></a><code>function <b>LoadLevelScene</b>(const URL: string; const CreateOctreeCollisions: boolean): <a href="CastleScene.TCastleScene.html">TCastleScene</a>;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<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="Placeholder"></a><code>function <b>Placeholder</b>(const Shape: <a href="CastleShapes.TShape.html">TShape</a>; const PlaceholderName: string): boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Handle a <code>placeholder</code> named in external modeler. Return <code>True</code> if this is indeed a recognized <code>placeholder</code> name, and it was handled and relevant shape should be removed from level geometry (to not be rendered).</p>
</td></tr>
</table>
<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="PlaceholdersEnd"></a><code>procedure <b>PlaceholdersEnd</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called after all placeholders have been processed, that is after <a class="normal" href="CastleLevels.TGameSceneManager.html#LoadLevel">TGameSceneManager.LoadLevel</a> placed initial creatures, items and other stuff on the level. Override it to do anything you want.</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="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent; AWorld: <a href="Castle3D.T3DWorld.html">T3DWorld</a>; MainScene: <a href="CastleScene.TCastleScene.html">TCastleScene</a>; DOMElement: TDOMElement); reintroduce; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Create new level instance. Called before resources (creatures and items) are initialized (override <a class="normal" href="CastleLevels.TLevelLogic.html#PlaceholdersEnd">PlaceholdersEnd</a> if you need to do something after creatures and items are added). You can modify MainScene contents here.
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AWorld</dt>
<dd><p>3D world items. We provide AWorld instance at construction, and the created <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> instance will be added to this AWorld, and you cannot change it later. This is necessary, as <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> descendants at construction may actually modify your world, and depend on it later.</dd>
<dt>DOMElement</dt>
<dd><p>An XML tree of level.xml file. You can read it however you want, to handle additional attributes in level.xml. You can use standard FPC DOM unit and classes, and add a handful of simple comfortable routines in <a class="normal" href="CastleXMLUtils.html">CastleXMLUtils</a> unit, for example you can use this to read a string attribute:
<p></p>
<pre class="longcode">
MyAttribute := DOMElement.AttributeStringDef(<span class="pascal_string">'my_attribute'</span>, <span class="pascal_string">'default value'</span>);
MyRequiredAttribute := DOMElement.AttributeString(<span class="pascal_string">'my_required_attribute'</span>);
</pre>
<p></dd>
</dl>
</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="BoundingBox"></a><code>function <b>BoundingBox</b>: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="World"></a><code>function <b>World</b>: <a href="Castle3D.T3DWorld.html">T3DWorld</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="PrepareNewPlayer"></a><code>procedure <b>PrepareNewPlayer</b>(NewPlayer: <a href="CastlePlayer.TPlayer.html">TPlayer</a>); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called when new player starts new game on this level. This may be used to equip the player with some basic weapon / items.
<p>This is never called or used by the engine itself. This does nothing in the default <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> class implementation.
<p>Your particular game, where you can best decide when the player "starts a new game" and when the player merely "continues the previous game", may call it. And you may override this in your <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> descendants to equip the player.</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">
</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="Time"></a><code>property <b>Time</b>: <a href="CastleTimeUtils.html#TFloatTime">TFloatTime</a> read FTime;</code></td>
</tr>
<tr><td colspan="2">
<p>
Time of the level, in seconds. Time 0 when level is created. This is updated in our <a class="normal" href="CastleLevels.TLevelLogic.html#Update">Update</a>.</p>
</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&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>
|
