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
|
<!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: CastleWarnings</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">
<h1 class="unit">Unit CastleWarnings</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td>Uses</td><td>Classes, Interfaces, Objects and Records</td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td>Constants</td><td><a class="section" href="#PasDoc-Variables">Variables</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Reporting warnings (<a class="normal" href="CastleWarnings.html#OnWarning">OnWarning</a>).</p>
<a name="PasDoc-Uses"></a><h2 class="overview">Overview</h2>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleWarnings.html#OnWarningWrite">OnWarningWrite</a></b>(const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleWarnings.html#OnWarningLog">OnWarningLog</a></b>(const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleWarnings.html#TWarningType">TWarningType</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleWarnings.html#TWarningProc">TWarningProc</a></b> = procedure (const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
</table>
<a name="PasDoc-Variables"></a><h3 class="summary">Variables</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleWarnings.html#OnWarning">OnWarning</a></b>: <a href="CastleWarnings.html#TWarningProc">TWarningProc</a> = @<a href="CastleWarnings.html#OnWarningLog">OnWarningLog</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnWarningWrite"></a><code>procedure <b>OnWarningWrite</b>(const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
<tr><td colspan="1">
<p>
Assign this to <a class="normal" href="CastleWarnings.html#OnWarning">OnWarning</a> to report warnings using <a class="normal" href="CastleUtils.html#WarningWrite">WarningWrite</a>, and log them too. For Windows programs with no console available, <a class="normal" href="CastleUtils.html#WarningWrite">WarningWrite</a> will make a message box, in all other cases the warning just goes to ErrOutput. The warning is also logged using <a class="normal" href="CastleLog.html">CastleLog</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnWarningLog"></a><code>procedure <b>OnWarningLog</b>(const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
<tr><td colspan="1">
<p>
Assign this to <a class="normal" href="CastleWarnings.html#OnWarning">OnWarning</a> to only log warnings using <a class="normal" href="CastleLog.html">CastleLog</a>.</p>
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TWarningType"></a><code><b>TWarningType</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Types of warnings.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
wtMinor: Something failed (like URL not available), but still the data is semantically correct. For data formats that have a precise specification (like VRML/X3D or Collada), this means that the file satisfies the specification, but there is a minor problem (like one of the referred URLs is not available).</li>
<li>
wtMajor: The data is invalid. For data formats that have a precise specification (like VRML/X3D or Collada), this means that the file is incorrect with respect to this specification. We can handle it, but other (less forgiving but still correct) software may reject it.
<p>It's strongly suggested to report this to the author of the file, as the file should really be corrected.</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TWarningProc"></a><code><b>TWarningProc</b> = procedure (const AType: <a href="CastleWarnings.html#TWarningType">TWarningType</a>; const Category, S: string);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnWarning"></a><code><b>OnWarning</b>: <a href="CastleWarnings.html#TWarningProc">TWarningProc</a> = @<a href="CastleWarnings.html#OnWarningLog">OnWarningLog</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Reporting warnings. Used by other units to report warnings about various data (images, sound files, 3D models), indicating that data is invalid in some way but we can continue.
<p>You can assign any procedure here. You can ignore, or report this warning in any way. If you want to be really strict about the data correctness, you can also raise an exception (or raise it only when type is wtMajor).
<p>The default behavior is to ignore possible warnings (as there is no safe cross-platform default place where they can be reported). Actually, you can initialize <a class="normal" href="CastleLog.html">CastleLog</a> to see warnings in the log. You can also assign your own callback to <code>OnWarning</code> to record and show warnings in any way.</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:13</em>
</span>
</td></tr></table></body></html>
|
