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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
<!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 TLevelInfo</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="TLevelInfo"></a><h1 class="cio">Class TLevelInfo</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="CastleLevels.html">CastleLevels</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TLevelInfo = class(TObject)</code></p>
<h2 class="description">Description</h2>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TLevelInfo</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><b><a href="CastleLevels.TLevelInfo.html#Element">Element</a></b>: TDOMElement;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a href="CastleLevels.TLevelInfo.html#Create">Create</a></b>;</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>destructor <b><a href="CastleLevels.TLevelInfo.html#Destroy">Destroy</a></b>; 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.TLevelInfo.html#LogicClass">LogicClass</a></b>: <a href="CastleLevels.html#TLevelLogicClass">TLevelLogicClass</a> read FLogicClass write FLogicClass;</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="CastleLevels.TLevelInfo.html#Name">Name</a></b>: string read FName write FName;</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="CastleLevels.TLevelInfo.html#SceneURL">SceneURL</a></b>: string read FSceneURL write FSceneURL;</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="CastleLevels.TLevelInfo.html#SceneFileName">SceneFileName</a></b>: string read FSceneURL write FSceneURL; deprecated;</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="CastleLevels.TLevelInfo.html#Title">Title</a></b>: string read FTitle write FTitle;</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="CastleLevels.TLevelInfo.html#TitleHint">TitleHint</a></b>: string read FTitleHint write FTitleHint;</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="CastleLevels.TLevelInfo.html#Number">Number</a></b>: Integer read FNumber write FNumber default 0;</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="CastleLevels.TLevelInfo.html#Demo">Demo</a></b>: boolean read FDemo write FDemo 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="CastleLevels.TLevelInfo.html#Played">Played</a></b>: boolean read FPlayed write FPlayed;</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="CastleLevels.TLevelInfo.html#DefaultPlayed">DefaultPlayed</a></b>: boolean read FDefaultPlayed write FDefaultPlayed;</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="CastleLevels.TLevelInfo.html#LoadingImage">LoadingImage</a></b>: <a href="CastleImages.TRGBImage.html">TRGBImage</a> read FLoadingImage write FLoadingImage;</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="CastleLevels.TLevelInfo.html#LoadingBarYPosition">LoadingBarYPosition</a></b>: Single
read FLoadingBarYPosition write FLoadingBarYPosition
default <a href="CastleProgress.TProgressUserInterface.html#DefaultBarYPosition">TProgressUserInterface.DefaultBarYPosition</a>;</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="CastleLevels.TLevelInfo.html#PlaceholderName">PlaceholderName</a></b>: <a href="CastleShapes.html#TPlaceholderName">TPlaceholderName</a>
read FPlaceholderName write FPlaceholderName;</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="CastleLevels.TLevelInfo.html#PlaceholderReferenceDirection">PlaceholderReferenceDirection</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>
read FPlaceholderReferenceDirection write FPlaceholderReferenceDirection;</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="CastleLevels.TLevelInfo.html#MusicSound">MusicSound</a></b>: <a href="CastleSoundEngine.html#TSoundType">TSoundType</a> read FMusicSound write FMusicSound
default <a href="CastleSoundEngine.html#stNone">stNone</a>;</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="Element"></a><code><b>Element</b>: TDOMElement;</code></td>
</tr>
<tr><td colspan="2">
</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</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="Destroy"></a><code>destructor <b>Destroy</b>; 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="LogicClass"></a><code>property <b>LogicClass</b>: <a href="CastleLevels.html#TLevelLogicClass">TLevelLogicClass</a> read FLogicClass write FLogicClass;</code></td>
</tr>
<tr><td colspan="2">
<p>
Level logic class. This is indicated by the "type" attribute in level.xml file. By default level logic uses a base <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> class, which corresponds to using <code>type="Level"</code> in level.xml file.
<p>Changing this allows to use a different ObjectPascal class to implement the level behavior. You can create your own <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> descendants and register them like
<p></p>
<pre class="longcode">
<span class="pascal_keyword">type</span>
TMyLevelLogic = <span class="pascal_keyword">class</span>(TLevelLogic)
<span class="pascal_comment">{ ... override whatever you want ... }</span>
<span class="pascal_keyword">end</span>;
<span class="pascal_numeric"></span>...
LevelLogicClasses[<span class="pascal_string">'MyLevel'</span>] := TMyLevelLogic;
</pre>
<p>
<p>And then you can use <code>type="MyLevel"</code> inside level.xml to use your class. Many advanced tricks are possible by implementing your own <a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> descendant. See Castle1 GameLevelSpecific.pas unit for some examples.</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="Name"></a><code>property <b>Name</b>: string read FName write FName;</code></td>
</tr>
<tr><td colspan="2">
<p>
Unique identifier of this level. This name may be useful in scripts, as <a class="normal" href="CastleLevels.TGameSceneManager.html#LoadLevel">TGameSceneManager.LoadLevel</a> parameter and such.
<p>For all (current and future) uses it should be a valid VRML/X3D and ObjectPascal identifier, so use only (English) letters, underscores and digits (and don't start with a digit).</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="SceneURL"></a><code>property <b>SceneURL</b>: string read FSceneURL write FSceneURL;</code></td>
</tr>
<tr><td colspan="2">
<p>
Main level 3D model. When the level is loaded, this scene will be set as <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#MainScene">TCastleSceneManager.MainScene</a>, so it determines the default viewpoint, background and such.
<p>Usually it also contains the most (if not all) of 3D level visible geometry, scripts and such. Although level logic (<a class="normal" href="CastleLevels.TLevelLogic.html">TLevelLogic</a> descendant determined by LevelClass) may also add any number of additional 3D objects (<a class="normal" href="Castle3D.T3D.html">T3D</a> instances) to the 3D world.</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="SceneFileName"></a><code>property <b>SceneFileName</b>: string read FSceneURL write FSceneURL; deprecated;</code></td>
</tr>
<tr><td colspan="2">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Deprecated name for <a class="normal" href="CastleLevels.TLevelInfo.html#SceneURL">SceneURL</a>.</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="Title"></a><code>property <b>Title</b>: string read FTitle write FTitle;</code></td>
</tr>
<tr><td colspan="2">
<p>
Nice name of the level for user. This should be user-friendly, so it can use spaces, non-English letters and such.
<p>The core engine (like this <a class="normal" href="CastleLevels.html">CastleLevels</a> unit) doesn't use this title much, it's only for progress bars and log messages.
<p>It is up to the final game code to use this title in more interesting ways. For example to show a choice of starting level to the user. The core engine doesn't make such "New Game" menus automatically (because various games may have widly different ideas how to make it and how to show it). But we give the developer tools to make such menus easily, for example you can use <a class="normal" href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a> for this.</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="TitleHint"></a><code>property <b>TitleHint</b>: string read FTitleHint write FTitleHint;</code></td>
</tr>
<tr><td colspan="2">
<p>
Additional text that may be displayed near level title.
<p>The engine doesn't use this property at all, it's only loaded from level.xml file. It is available for your "New Game" (or similar screen) implementation (see <a class="normal" href="CastleLevels.TLevelInfo.html#Title">Title</a> for more comments about this).</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="Number"></a><code>property <b>Number</b>: Integer read FNumber write FNumber default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
Level number.
<p>The engine doesn't use this property at all, it's only loaded from level.xml file. It is available for your "New Game" (or similar screen) implementation (see <a class="normal" href="CastleLevels.TLevelInfo.html#Title">Title</a> for more comments about this).
<p>For example level number may be used to order levels in the menu. This <i>does not</i> determine the order in which levels are played, as levels do not have to be played in a linear order.</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="Demo"></a><code>property <b>Demo</b>: boolean read FDemo write FDemo default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Is it a demo level.
<p>The engine doesn't use this property at all, it's only loaded from level.xml file. It is available for your "New Game" (or similar screen) implementation (see <a class="normal" href="CastleLevels.TLevelInfo.html#Title">Title</a> for more comments about this).</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="Played"></a><code>property <b>Played</b>: boolean read FPlayed write FPlayed;</code></td>
</tr>
<tr><td colspan="2">
<p>
Was the level played.
<p>This is automatically managed. Basically, we set it to <code>True</code> when the level is played, and we save it to user preferences.
<p>Details: </p>
<ul class="paragraph_spacing">
<li><p>It is set to <code>True</code> when loading level.</p></li>
<li><p>It is saved to disk (user preferences file) when game exits, and loaded when game starts. As long as you call <code>Config.Load</code>, <code>Config.Save</code> from <a class="normal" href="CastleConfig.html">CastleConfig</a> unit. To load, you must also call explicitly <a class="normal" href="CastleLevels.TLevelInfoList.html#LoadFromConfig">Levels.LoadFromConfig</a> now.</p></li>
<li><p>The default value comes from <a class="normal" href="CastleLevels.TLevelInfo.html#DefaultPlayed">DefaultPlayed</a> property, which in turn is loaded from level.xml file, and by default is <code>False</code>. To allows you to artificially mark some levels as "Played" on the first game run, which may be helpful if you use this property e.g. to filter the levels in "New Game" menu.</p></li>
</ul>
<p>
<p>The engine doesn't look at this property for anything, whether the level is played or not has no influence over how we work. It is just available for your game, for example to use in your "New Game" (or similar screen) implementation (see <a class="normal" href="CastleLevels.TLevelInfo.html#Title">Title</a> for more comments about this).</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="DefaultPlayed"></a><code>property <b>DefaultPlayed</b>: boolean read FDefaultPlayed write FDefaultPlayed;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should the level be initially considered "played". This determines the initial value of <a class="normal" href="CastleLevels.TLevelInfo.html#Played">Played</a> property (if nothing was stored in user preferences about this level, see <a class="normal" href="CastleLevels.TLevelInfoList.html#LoadFromConfig">TLevelInfoList.LoadFromConfig</a>; or if <a class="normal" href="CastleLevels.TLevelInfoList.html#LoadFromConfig">TLevelInfoList.LoadFromConfig</a> is not called by the game).
<p>How is this information useful, depends on a particular game. For example, some games may decide to show in the "New Game" menu levels only with Played=true. Some games may simply ignore it.</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="LoadingImage"></a><code>property <b>LoadingImage</b>: <a href="CastleImages.TRGBImage.html">TRGBImage</a> read FLoadingImage write FLoadingImage;</code></td>
</tr>
<tr><td colspan="2">
<p>
Background image shown when loading the level, <code>Nil</code> if none. This is loaded from URL indicated by attribute loading_image in level.xml.</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="LoadingBarYPosition"></a><code>property <b>LoadingBarYPosition</b>: Single
read FLoadingBarYPosition write FLoadingBarYPosition
default <a href="CastleProgress.TProgressUserInterface.html#DefaultBarYPosition">TProgressUserInterface.DefaultBarYPosition</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Vertical position of progress bar when loading the level. Between 0 and 1, default value 0.5 means "middle of the screen". Should be synchronized with how <a class="normal" href="CastleLevels.TLevelInfo.html#LoadingImage">LoadingImage</a> looks (if you set it), to make the progress when loading level look nice.
<p>Technically, this is used for <a class="normal" href="CastleProgress.TProgressUserInterface.html#BarYPosition">TProgressUserInterface.BarYPosition</a>.</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="PlaceholderName"></a><code>property <b>PlaceholderName</b>: <a href="CastleShapes.html#TPlaceholderName">TPlaceholderName</a>
read FPlaceholderName write FPlaceholderName;</code></td>
</tr>
<tr><td colspan="2">
<p>
Placeholder detection method. See <a class="normal" href="CastleShapes.html#TPlaceholderName">TPlaceholderName</a>, and see <a class="normal" href="CastleLevels.TGameSceneManager.html#LoadLevel">TGameSceneManager.LoadLevel</a> for a description when we use placeholders. Default value is <code><a class="normal" href="CastleShapes.html#PlaceholderNames">PlaceholderNames</a>['x3dshape']</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="PlaceholderReferenceDirection"></a><code>property <b>PlaceholderReferenceDirection</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>
read FPlaceholderReferenceDirection write FPlaceholderReferenceDirection;</code></td>
</tr>
<tr><td colspan="2">
<p>
How to interpret the placeholders direction (like the initial creature direction on the level). Some placeholders (currently, only creatures) may be used to determine initial direction of the resource. For example, the direction the creature is initially facing. This direction is calculated as the transformation of given placeholder applied to this 3D vector.
<p>The correct value may depend on the exporter you used to create 3D models, and on the exporter settings (how and if it rotates the model when exporting, and is this rotation recorded in placeholder transformation or applied directly to mesh coordinates). It may also depend on personal preference, as it determines how you set resources in your 3D modelling tool (like Blender).
<p>Fortunately, the default value (+X vector) is suitable for at least 2 common situations:
<p></p>
<ol class="paragraph_spacing">
<li value="1"><p>If your exporter rotates the world to turn +Z up into +Y up. (This is the case of default Blender X3D exporter with default settings.)</p></li>
<li value="2"><p>If your exporter doesn't rotate the world. (You can configure Blender exporter to behave like this. You may also then configure engine to use +Z as up vector for everything, see "Which way is up?" on [<a href="http://castle-engine.sourceforge.net/tutorial_up.php">http://castle-engine.sourceforge.net/tutorial_up.php</a>].)</p></li>
</ol>
<p>
<p>In Blender it's useful to enable the "Display -> Wire" option for placeholder objects, then Blender will show arrows inside the placeholder. +X of the arrow determines the default direction understood by our engine.</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="MusicSound"></a><code>property <b>MusicSound</b>: <a href="CastleSoundEngine.html#TSoundType">TSoundType</a> read FMusicSound write FMusicSound
default <a href="CastleSoundEngine.html#stNone">stNone</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Music played when entering the level.</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>
|
