File: CastleLevels.TLevelInfoList.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 (132 lines) | stat: -rw-r--r-- 8,588 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
 
<!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 TLevelInfoList</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="TLevelInfoList"></a><h1 class="cio">Class TLevelInfoList</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>Properties</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 TLevelInfoList = class(specialize TFPGObjectList&lt;TLevelInfo&gt;)</code></p>
<h2 class="description">Description</h2>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TFPGObjectList</li>
<li class="thisitem">TLevelInfoList</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleLevels.TLevelInfoList.html#FindName">FindName</a></b>(const AName: string): <a  href="CastleLevels.TLevelInfo.html">TLevelInfo</a>;</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.TLevelInfoList.html#LoadFromFiles">LoadFromFiles</a></b>(const LevelsPath: string);</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.TLevelInfoList.html#LoadFromFiles">LoadFromFiles</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>procedure <b><a  href="CastleLevels.TLevelInfoList.html#AddFromFile">AddFromFile</a></b>(const URL: string);</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.TLevelInfoList.html#LoadFromConfig">LoadFromConfig</a></b>;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FindName"></a><code>function <b>FindName</b>(const AName: string): <a  href="CastleLevels.TLevelInfo.html">TLevelInfo</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
raises Exception if such Name is not on the list.</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="LoadFromFiles"></a><code>procedure <b>LoadFromFiles</b>(const LevelsPath: string);</code></td>
</tr>
<tr><td colspan="2">
<p>
Add all available levels found by scanning for level.xml inside data directory. Overloaded version without parameter just looks inside <a class="normal" href="CastleFilesUtils.html#ApplicationData">ApplicationData</a>. For the specification of level.xml format see [<a  href="http://castle-engine.sourceforge.net/creating_data_levels.php">http://castle-engine.sourceforge.net/creating_data_levels.php</a>] .

<p>This should be called after resources (creatures and items) are known, as they may be referenced by level.xml files. So call <a class="normal" href="CastleResources.T3DResourceList.html#LoadFromFiles">Resources.LoadFromFiles</a> <i>before</i> calling this (if you want to use any creatures / items at all, of course).

<p>All <a class="normal" href="CastleLevels.TLevelInfo.html#Played">TLevelInfo.Played</a> values are initially set to <code>False</code>. You must call <a class="normal" href="CastleLevels.TLevelInfoList.html#LoadFromConfig">LoadFromConfig</a> <i>after</i> calling this to read <a class="normal" href="CastleLevels.TLevelInfo.html#Played">TLevelInfo.Played</a> values from user preferences file.

<p>Note that on Android, searching the Android asset filesystem recursively is not possible (this is a fault of Android NDK API...). So instead of this method, you should use <a class="normal" href="CastleLevels.TLevelInfoList.html#AddFromFile">AddFromFile</a> repeatedly to explicitly list all level.xml locations.

<p></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="LoadFromFiles"></a><code>procedure <b>LoadFromFiles</b>;</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="AddFromFile"></a><code>procedure <b>AddFromFile</b>(const URL: string);</code></td>
</tr>
<tr><td colspan="2">
<p>
Add a single level information from the XML file at given location. The given XML file must have &lt;level&gt; root element and be written according to <a  href="http://castle-engine.sourceforge.net/creating_data_levels.php">http://castle-engine.sourceforge.net/creating_data_levels.php</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="LoadFromConfig"></a><code>procedure <b>LoadFromConfig</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
For all available levels, read their <a class="normal" href="CastleLevels.TLevelInfo.html#Played">TLevelInfo.Played</a> from user preferences.

<p>This is useful only if you actually look at <a class="normal" href="CastleLevels.TLevelInfo.html#Played">TLevelInfo.Played</a> for any purpose (for example, to decide which levels are displayed in the menu). By default, our engine doesn't look at <a class="normal" href="CastleLevels.TLevelInfo.html#Played">TLevelInfo.Played</a> for anything.</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&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>