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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
|
<!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: CastleNotifications: Class TCastleNotifications</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="TCastleNotifications"></a><h1 class="cio">Class TCastleNotifications</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="CastleNotifications.html">CastleNotifications</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCastleNotifications = class(<a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Notifications displayed in the OpenGL window. The idea is to display messages about something happening at the bottom / top of the screen. These messages disappear by themselves after some short time.
<p>Similar to older FPS games messages, e.g. DOOM, Quake, Duke Nukem 3D. Suitable for game messages like "Picked up 20 ammo" or "Player Foo joined game".
<p>This is a <a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a> descendant, so to use it — just add it to <a class="normal" href="CastleWindow.TCastleWindowCustom.html#Controls">TCastleWindowCustom.Controls</a> or <a class="normal" href="CastleControl.TCastleControlCustom.html#Controls">TCastleControlCustom.Controls</a>. Call <a class="normal" href="CastleNotifications.TCastleNotifications.html#Show">Show</a> to display a message.</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="CastleUIControls.TInputListener.html">TInputListener</a></li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a></li>
<li class="thisitem">TCastleNotifications</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultMaxMessages">DefaultMaxMessages</a></b> = 4;</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>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultMessagesTimeout">DefaultMessagesTimeout</a></b> = 5000;</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>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalPosition">DefaultHorizontalPosition</a></b> = <a href="CastleUIControls.html#hpMiddle">hpMiddle</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>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalPosition">DefaultVerticalPosition</a></b> = vpDown;</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>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalMargin">DefaultHorizontalMargin</a></b> = 10;</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>internal const <b><a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalMargin">DefaultVerticalMargin</a></b> = 1;</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="CastleNotifications.TCastleNotifications.html#Create">Create</a></b>(AOwner: TComponent); 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>destructor <b><a href="CastleNotifications.TCastleNotifications.html#Destroy">Destroy</a></b>; 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>procedure <b><a href="CastleNotifications.TCastleNotifications.html#Show">Show</a></b>(const s: string); overload;</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="CastleNotifications.TCastleNotifications.html#Show">Show</a></b>(s: TStringList); overload;</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="CastleNotifications.TCastleNotifications.html#Clear">Clear</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="CastleNotifications.TCastleNotifications.html#Update">Update</a></b>(const SecondsPassed: Single; var HandleInput: boolean); 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>procedure <b><a href="CastleNotifications.TCastleNotifications.html#Render">Render</a></b>; 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>function <b><a href="CastleNotifications.TCastleNotifications.html#GetExists">GetExists</a></b>: boolean; 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="CastleNotifications.TCastleNotifications.html#Color">Color</a></b>: <a href="CastleColors.html#TCastleColor">TCastleColor</a> read FColor write FColor;</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="CastleNotifications.TCastleNotifications.html#History">History</a></b>: <a href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> read FHistory;</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="CastleNotifications.TCastleNotifications.html#PositionX">PositionX</a></b>: Integer read FPositionX write FPositionX;</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="CastleNotifications.TCastleNotifications.html#PositionY">PositionY</a></b>: Integer read FPositionY write FPositionY;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#MaxMessages">MaxMessages</a></b>: integer
read FMaxMessages write FMaxMessages default <a href="CastleNotifications.TCastleNotifications.html#DefaultMaxMessages">DefaultMaxMessages</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#Timeout">Timeout</a></b>: <a href="CastleTimeUtils.html#TMilisecTime">TMilisecTime</a>
read FTimeout write FTimeout default <a href="CastleNotifications.TCastleNotifications.html#DefaultMessagesTimeout">DefaultMessagesTimeout</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#HorizontalPosition">HorizontalPosition</a></b>: <a href="CastleNotifications.html#THorizontalPosition">THorizontalPosition</a> read FHorizontalPosition
write FHorizontalPosition default <a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalPosition">DefaultHorizontalPosition</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#VerticalPosition">VerticalPosition</a></b>: <a href="CastleNotifications.html#TVerticalPosition">TVerticalPosition</a> read FVerticalPosition
write FVerticalPosition default <a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalPosition">DefaultVerticalPosition</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#HorizontalMargin">HorizontalMargin</a></b>: Integer read FHorizontalMargin write FHorizontalMargin
default <a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalMargin">DefaultHorizontalMargin</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#VerticalMargin">VerticalMargin</a></b>: Integer read FVerticalMargin write FVerticalMargin
default <a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalMargin">DefaultVerticalMargin</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleNotifications.TCastleNotifications.html#CollectHistory">CollectHistory</a></b>: boolean read FCollectHistory write FCollectHistory
default false;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DefaultMaxMessages"></a><code>internal const <b>DefaultMaxMessages</b> = 4;</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="DefaultMessagesTimeout"></a><code>internal const <b>DefaultMessagesTimeout</b> = 5000;</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="DefaultHorizontalPosition"></a><code>internal const <b>DefaultHorizontalPosition</b> = <a href="CastleUIControls.html#hpMiddle">hpMiddle</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DefaultVerticalPosition"></a><code>internal const <b>DefaultVerticalPosition</b> = vpDown;</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="DefaultHorizontalMargin"></a><code>internal const <b>DefaultHorizontalMargin</b> = 10;</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="DefaultVerticalMargin"></a><code>internal const <b>DefaultVerticalMargin</b> = 1;</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>(AOwner: TComponent); 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="Destroy"></a><code>destructor <b>Destroy</b>; 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="Show"></a><code>procedure <b>Show</b>(const s: string); overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Show new message. An overloaded version that takes a single string will detect newlines in the string automatically so a message may be multi-line. The messages will be automatically broken to fit on the screen width with given font. </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="Show"></a><code>procedure <b>Show</b>(s: TStringList); overload;</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="Clear"></a><code>procedure <b>Clear</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clear all messages.</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 HandleInput: boolean); 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="Render"></a><code>procedure <b>Render</b>; 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="GetExists"></a><code>function <b>GetExists</b>: boolean; 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="Color"></a><code>property <b>Color</b>: <a href="CastleColors.html#TCastleColor">TCastleColor</a> read FColor write FColor;</code></td>
</tr>
<tr><td colspan="2">
<p>
Color used to draw messages. Default value is <a class="normal" href="CastleColors.html#Yellow">yellow</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="History"></a><code>property <b>History</b>: <a href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> read FHistory;</code></td>
</tr>
<tr><td colspan="2">
<p>
All the messages passed to <a class="normal" href="CastleNotifications.TCastleNotifications.html#Show">Show</a>, collected only if <a class="normal" href="CastleNotifications.TCastleNotifications.html#CollectHistory">CollectHistory</a>. May be <code>Nil</code> when not <a class="normal" href="CastleNotifications.TCastleNotifications.html#CollectHistory">CollectHistory</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="PositionX"></a><code>property <b>PositionX</b>: Integer read FPositionX write FPositionX;</code></td>
</tr>
<tr><td colspan="2">
<p>
Position shift, relative to position set by <a class="normal" href="CastleNotifications.TCastleNotifications.html#HorizontalPosition">HorizontalPosition</a> and <a class="normal" href="CastleNotifications.TCastleNotifications.html#VerticalPosition">VerticalPosition</a>. TODO: we should make positioning common for all controls, using Left, Bottom, or some Autoxxx spec.</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="PositionY"></a><code>property <b>PositionY</b>: Integer read FPositionY write FPositionY;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="MaxMessages"></a><code>property <b>MaxMessages</b>: integer
read FMaxMessages write FMaxMessages default <a href="CastleNotifications.TCastleNotifications.html#DefaultMaxMessages">DefaultMaxMessages</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
How many message lines should be visible on the screen, at maximum.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="Timeout"></a><code>property <b>Timeout</b>: <a href="CastleTimeUtils.html#TMilisecTime">TMilisecTime</a>
read FTimeout write FTimeout default <a href="CastleNotifications.TCastleNotifications.html#DefaultMessagesTimeout">DefaultMessagesTimeout</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
How long a given message should be visible on the screen, in miliseconds. Message stops being visible when this timeout passed, or when we need more space for new messages (see <a class="normal" href="CastleNotifications.TCastleNotifications.html#MaxMessages">MaxMessages</a>).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="HorizontalPosition"></a><code>property <b>HorizontalPosition</b>: <a href="CastleNotifications.html#THorizontalPosition">THorizontalPosition</a> read FHorizontalPosition
write FHorizontalPosition default <a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalPosition">DefaultHorizontalPosition</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="VerticalPosition"></a><code>property <b>VerticalPosition</b>: <a href="CastleNotifications.html#TVerticalPosition">TVerticalPosition</a> read FVerticalPosition
write FVerticalPosition default <a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalPosition">DefaultVerticalPosition</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="HorizontalMargin"></a><code>property <b>HorizontalMargin</b>: Integer read FHorizontalMargin write FHorizontalMargin
default <a href="CastleNotifications.TCastleNotifications.html#DefaultHorizontalMargin">DefaultHorizontalMargin</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Margins, in pixels, from the border of the container (window or such). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="VerticalMargin"></a><code>property <b>VerticalMargin</b>: Integer read FVerticalMargin write FVerticalMargin
default <a href="CastleNotifications.TCastleNotifications.html#DefaultVerticalMargin">DefaultVerticalMargin</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="CollectHistory"></a><code>property <b>CollectHistory</b>: boolean read FCollectHistory write FCollectHistory
default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Turn this on to have all the messages you pass to <a class="normal" href="CastleNotifications.TCastleNotifications.html#Show">Show</a> be collected inside <a class="normal" href="CastleNotifications.TCastleNotifications.html#History">History</a> string list. <a class="normal" href="CastleNotifications.TCastleNotifications.html#History">History</a> is expanded by <a class="normal" href="CastleNotifications.TCastleNotifications.html#Show">Show</a>, it is cleared by <a class="normal" href="CastleNotifications.TCastleNotifications.html#Clear">Clear</a>, just like the notifications on screen. However, unlike the visible messages, it has unlimited size (messages there are not removed when <a class="normal" href="CastleNotifications.TCastleNotifications.html#MaxMessages">MaxMessages</a> or <a class="normal" href="CastleNotifications.TCastleNotifications.html#Timeout">Timeout</a> take action), and messages inside are not broken to honour screen width.
<p>This is useful if you want to show the player a history of messages (in case they missed the message in game).</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>
|