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
|
<!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: CastleResources: Class T3DResourceList</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="T3DResourceList"></a><h1 class="cio">Class T3DResourceList</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="CastleResources.html">CastleResources</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type T3DResourceList = class(specialize TFPGObjectList<T3DResource>)</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">T3DResourceList</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="CastleResources.T3DResourceList.html#FindName">FindName</a></b>(const AName: string; const NilWhenNotFound: boolean = false): <a href="CastleResources.T3DResource.html">T3DResource</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="CastleResources.T3DResourceList.html#LoadFromFiles">LoadFromFiles</a></b>(const Path: string; const Reload: boolean = 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>procedure <b><a href="CastleResources.T3DResourceList.html#LoadFromFiles">LoadFromFiles</a></b>(const Reload: boolean = false);</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="CastleResources.T3DResourceList.html#AddFromFile">AddFromFile</a></b>(const URL: string; const Reload: boolean = 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>procedure <b><a href="CastleResources.T3DResourceList.html#LoadResources">LoadResources</a></b>(ParentElement: TDOMElement);</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="CastleResources.T3DResourceList.html#Prepare">Prepare</a></b>(const BaseLights: <a href="Castle3D.html#TAbstractLightInstancesList">TAbstractLightInstancesList</a>; const GravityUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const ResourcesName: string = 'resources');</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="CastleResources.T3DResourceList.html#Release">Release</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; const NilWhenNotFound: boolean = false): <a href="CastleResources.T3DResource.html">T3DResource</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Find resource with given <a class="normal" href="CastleResources.T3DResource.html#Name">T3DResource.Name</a>. </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><code>Exception</code></dt>
<dd>if not found and NilWhenNotFound = false.</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="LoadFromFiles"></a><code>procedure <b>LoadFromFiles</b>(const Path: string; const Reload: boolean = false);</code></td>
</tr>
<tr><td colspan="2">
<p>
Load all resources (creatures and items) information from resource.xml files found in given Path. Overloaded version without Path just scans the whole <a class="normal" href="CastleFilesUtils.html#ApplicationData">ApplicationData</a> directory.
<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="CastleResources.T3DResourceList.html#AddFromFile">AddFromFile</a> repeatedly to explicitly list all resource.xml locations.
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Reload</dt>
<dd>If Reload, then we will not clear the initial list contents. Instead, resource.xml files found that refer to the existing <a class="normal" href="CastleResources.T3DResource.html#Name">T3DResource.Name</a> will cause <a class="normal" href="CastleResources.T3DResource.html#LoadFromFile">T3DResource.LoadFromFile</a> call on an existing resource. Using Reload is a nice debug feature, if you want to reload configuration from resource.xml files (and eventually add new resources in new resource.xml files), but you don't want to recreate existing resource instances.</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="LoadFromFiles"></a><code>procedure <b>LoadFromFiles</b>(const Reload: boolean = false);</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="AddFromFile"></a><code>procedure <b>AddFromFile</b>(const URL: string; const Reload: boolean = false);</code></td>
</tr>
<tr><td colspan="2">
<p>
Load a single resource from resource.xml file.
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Reload</dt>
<dd>If <code>True</code>, and the loaded resource will have a name matching existing <a class="normal" href="CastleResources.T3DResource.html#Name">T3DResource.Name</a>, we will replace the current resource. Otherwise, we'll make an exception.</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="LoadResources"></a><code>procedure <b>LoadResources</b>(ParentElement: TDOMElement);</code></td>
</tr>
<tr><td colspan="2">
<p>
Reads <prepare_resources> XML element. <prepare_resources> element is an optional child of given ParentElement. Sets current list value with all mentioned required resources (subset of <a class="normal" href="CastleResources.html#Resources">Resources</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="Prepare"></a><code>procedure <b>Prepare</b>(const BaseLights: <a href="Castle3D.html#TAbstractLightInstancesList">TAbstractLightInstancesList</a>; const GravityUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const ResourcesName: string = 'resources');</code></td>
</tr>
<tr><td colspan="2">
<p>
Prepare / release all resources on 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="Release"></a><code>procedure <b>Release</b>;</code></td>
</tr>
<tr><td colspan="2">
</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:11</em>
</span>
</td></tr></table></body></html>
|
